Sakurai/pdf.js
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update the GlobalWorkerOptions.workerSrc JSDoc comment

Browse Source 
This particular JSDoc comment is fairly old and it also contains some now unrelated/confusing information.
The only way to *guarantee* that the PDF.js library works as expected is to correctly set the global `workerSrc`[1], hence giving the impression that the option isn't strictly necessary is thus incorrect.

---
[1] Since advertising the fallbackWorkerSrc functionality definitely seems like the *wrong* thing to do.
This commit is contained in:
Jonas Jenwald 2020-01-19 12:31:58 +01:00
parent 40f531ee87
commit ee87e898db
1 changed files with 3 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/display/worker_options.js
View File

@ -25,12 +25,10 @@ GlobalWorkerOptions.workerPort =
: GlobalWorkerOptions.workerPort; : GlobalWorkerOptions.workerPort;
/** /**
* Path and filename of the worker file. Required when workers are enabled in * A string containing the path and filename of the worker file.
* development mode. If unspecified in production builds, the worker will be
* loaded based on the location of the `pdf.js` file.
* *
* NOTE: The `workerSrc` should always be set in custom applications, in order * NOTE: The `workerSrc` option should always be set, in order to prevent any
* to prevent issues caused by third-party frameworks and libraries. * issues when using the PDF.js library.
* @var {string} * @var {string}
*/ */
GlobalWorkerOptions.workerSrc = GlobalWorkerOptions.workerSrc =