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

Merge pull request #13638 from Snuffleupagus/api-tweak-docs

Browse Source 
A couple of smaller JSDocs tweaks in `src/display/api.js`
This commit is contained in:
Tim van der Meij 2021-06-27 12:47:57 +02:00 committed by GitHub
commit d644b66c72
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
src/display/api.js
View File

@ -114,6 +114,12 @@ function setPDFNetworkStreamFactory(pdfNetworkStreamFactory) {
* } TypedArray
*/
/**
* @typedef {Object} RefProxy
* @property {number} num
* @property {number} gen
*/
/**
* Document initialization / loading parameters object.
*
@ -508,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
* (such as network requests) and provides a way to listen for completion,
@ -522,8 +534,7 @@ function _fetchDocument(worker, source, pdfDataRangeTransport, docId) {
* {@link PasswordResponses}).
* @property {function} [onProgress] - Callback to be able to monitor the
* loading progress of the PDF file (necessary to implement e.g. a loading
* bar). The callback receives an {Object} with the properties `loaded`
* ({number}) and `total` ({number}) that indicate how many bytes are loaded.
* bar). The callback receives an {@link OnProgressParameters} argument.
* @property {function} [onUnsupportedFeature] - Callback for when an
* unsupported feature is used in the PDF document. The callback receives an
* {@link UNSUPPORTED_FEATURES} argument.
@ -575,9 +586,8 @@ const PDFDocumentLoadingTask = (function PDFDocumentLoadingTaskClosure() {
/**
* Callback to be able to monitor the loading progress of the PDF file
* (necessary to implement e.g. a loading bar). The callback receives
* an {Object} with the properties `loaded` ({number}) and `total`
* ({number}) that indicate how many bytes are loaded.
* (necessary to implement e.g. a loading bar).
* The callback receives an {@link OnProgressParameters} argument.
* @type {function}
*/
this.onProgress = null;
@ -761,12 +771,6 @@ class PDFDocumentProxy {
return this._transport.getPage(pageNumber);
}
/**
* @typedef {Object} RefProxy
* @property {number} num
* @property {number} gen
*/
/**
* @param {RefProxy} ref - The page reference.
* @returns {Promise<number>} A promise that is resolved with the page index,
@ -1231,8 +1235,7 @@ class PDFPageProxy {
}
/**
* @type {Object} The reference that points to this page. It has `num` and
* `gen` properties.
* @type {RefProxy | null} The reference that points to this page.
*/
get ref() {
return this._pageInfo.ref;