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

Fix incorrect types in the API documentation

Browse Source
This commit is contained in:
Tim van der Meij 2020-08-02 20:09:31 +02:00
parent 3116216e1d
commit ba4a07ce07
No known key found for this signature in database
GPG Key ID: 8C3FD2925A5F2762
1 changed files with 10 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
src/display/api.js
View File

@ -666,8 +666,8 @@ class PDFDocumentProxy {
} }
/** /**
* @returns {Promise<Object<string,any>>} A promise that is resolved with * @returns {Promise<Object<string, Array<any>>>} A promise that is resolved
* a lookup table for mapping named destinations to reference numbers. * with a mapping from named destinations to references.
* *
* This can be slow for large documents. Use `getDestination` instead. * This can be slow for large documents. Use `getDestination` instead.
*/ */
@ -685,10 +685,9 @@ class PDFDocumentProxy {
} }
/** /**
* @returns {Promise<Array<string> | null>} A promise that is * @returns {Promise<Array<string> | null>} A promise that is resolved with
* resolved with an {Array} containing the page labels that correspond to * an {Array} containing the page labels that correspond to the page
* the page indexes, or `null` when no page labels are present in the PDF * indexes, or `null` when no page labels are present in the PDF file.
* file.
*/ */
getPageLabels() { getPageLabels() {
return this._transport.getPageLabels(); return this._transport.getPageLabels();
@ -711,8 +710,9 @@ class PDFDocumentProxy {
} }
/** /**
* @returns {Promise<Object>} A promise that is resolved with an {Object} * @returns {Promise<Object | null>} A promise that is resolved with an
* containing the viewer preferences. * {Object} containing the viewer preferences, or `null` when no viewer
* preferences are present in the PDF file.
*/ */
getViewerPreferences() { getViewerPreferences() {
return this._transport.getViewerPreferences(); return this._transport.getViewerPreferences();
@ -787,7 +787,7 @@ class PDFDocumentProxy {
} }
/** /**
* @returns {Promise<Array<string | null>>} A promise that is resolved with * @returns {Promise<Array<number> | null>} A promise that is resolved with
* an {Array} that contains the permission flags for the PDF document, or * an {Array} that contains the permission flags for the PDF document, or
* `null` when no permissions are present in the PDF file. * `null` when no permissions are present in the PDF file.
*/ */
@ -2703,8 +2703,7 @@ class RenderTask {
* Callback for incremental rendering -- a function that will be called * Callback for incremental rendering -- a function that will be called
* each time the rendering is paused. To continue rendering call the * each time the rendering is paused. To continue rendering call the
* function that is the first argument to the callback. * function that is the first argument to the callback.
* @callback * @type {function}
* @param {function}
*/ */
this.onContinue = null; this.onContinue = null;
} }