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

Use the RefProxy typedef in more JSDoc comments in src/display/api.js

Browse Source
This commit is contained in:
Jonas Jenwald 2021-06-27 11:34:59 +02:00
parent d7f8a0e9b9
commit ea4b162328
1 changed files with 7 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
src/display/api.js
View File

@ -114,6 +114,12 @@ function setPDFNetworkStreamFactory(pdfNetworkStreamFactory) {
* } TypedArray * } TypedArray
*/ */
/**
* @typedef {Object} RefProxy
* @property {number} num
* @property {number} gen
*/
/** /**
* Document initialization / loading parameters object. * Document initialization / loading parameters object.
* *
@ -761,12 +767,6 @@ class PDFDocumentProxy {
return this._transport.getPage(pageNumber); return this._transport.getPage(pageNumber);
} }
/**
* @typedef {Object} RefProxy
* @property {number} num
* @property {number} gen
*/
/** /**
* @param {RefProxy} ref - The page reference. * @param {RefProxy} ref - The page reference.
* @returns {Promise<number>} A promise that is resolved with the page index, * @returns {Promise<number>} A promise that is resolved with the page index,
@ -1231,8 +1231,7 @@ class PDFPageProxy {
} }
/** /**
* @type {Object} The reference that points to this page. It has `num` and * @type {RefProxy | null} The reference that points to this page.
* `gen` properties.
*/ */
get ref() { get ref() {
return this._pageInfo.ref; return this._pageInfo.ref;