Merge pull request #11520 from Snuffleupagus/workerSrc-docs

Update the `GlobalWorkerOptions.workerSrc` JSDoc comment
This commit is contained in:
Tim van der Meij 2020-01-19 17:18:40 +01:00 committed by GitHub
commit 1097fa156c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

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