Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update the GlobalWorkerOptions.workerSrc JSDoc comment #11520

Merged
merged 1 commit into from
Jan 19, 2020
Merged

Update the GlobalWorkerOptions.workerSrc JSDoc comment #11520

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 3 additions & 5 deletions src/display/worker_options.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 =
Expand Down