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

Add a OnProgressParameters typedef to reduce (some) duplication in src/display/api.js

Browse Source
This commit is contained in:
Jonas Jenwald 2021-06-27 11:50:52 +02:00
parent ea4b162328
commit d02146b13b
1 changed files with 9 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
src/display/api.js
View File

@ -514,6 +514,12 @@ function _fetchDocument(worker, source, pdfDataRangeTransport, docId) {
}); });
} }
/**
* @typedef {Object} OnProgressParameters
* @property {number} loaded - Currently loaded number of bytes.
* @property {number} total - Total number of bytes in the PDF file.
*/
/** /**
* The loading task controls the operations required to load a PDF document * The loading task controls the operations required to load a PDF document
* (such as network requests) and provides a way to listen for completion, * (such as network requests) and provides a way to listen for completion,
@ -528,8 +534,7 @@ function _fetchDocument(worker, source, pdfDataRangeTransport, docId) {
* {@link PasswordResponses}). * {@link PasswordResponses}).
* @property {function} [onProgress] - Callback to be able to monitor the * @property {function} [onProgress] - Callback to be able to monitor the
* loading progress of the PDF file (necessary to implement e.g. a loading * loading progress of the PDF file (necessary to implement e.g. a loading
* bar). The callback receives an {Object} with the properties `loaded` * bar). The callback receives an {@link OnProgressParameters} argument.
* ({number}) and `total` ({number}) that indicate how many bytes are loaded.
* @property {function} [onUnsupportedFeature] - Callback for when an * @property {function} [onUnsupportedFeature] - Callback for when an
* unsupported feature is used in the PDF document. The callback receives an * unsupported feature is used in the PDF document. The callback receives an
* {@link UNSUPPORTED_FEATURES} argument. * {@link UNSUPPORTED_FEATURES} argument.
@ -581,9 +586,8 @@ const PDFDocumentLoadingTask = (function PDFDocumentLoadingTaskClosure() {
/** /**
* Callback to be able to monitor the loading progress of the PDF file * Callback to be able to monitor the loading progress of the PDF file
* (necessary to implement e.g. a loading bar). The callback receives * (necessary to implement e.g. a loading bar).
* an {Object} with the properties `loaded` ({number}) and `total` * The callback receives an {@link OnProgressParameters} argument.
* ({number}) that indicate how many bytes are loaded.
* @type {function} * @type {function}
*/ */
this.onProgress = null; this.onProgress = null;