Merge pull request #13450 from Snuffleupagus/getPageIndex-JSDoc

Fix the JSDocs for `PDFDocumentProxy.getPageIndex` (issue 13449)
mozilla · May 27, 2021 · d285580 · d285580
2 parents f587d59 + 70c79c6
commit d285580
Showing 1 changed file with 9 additions and 5 deletions.
diff --git a/src/display/api.js b/src/display/api.js
@@ -708,11 +708,15 @@ class PDFDocumentProxy {
   }
 
   /**
-   * @param {{num: number, gen: number}} ref - The page reference. Must have
-   *   the `num` and `gen` properties.
-   * @returns {Promise<{num: number, gen: number}>} A promise that is resolved
-   *   with the page index (starting from zero) that is associated with the
-   *   reference.
+   * @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,
+   *   starting from zero, that is associated with the reference.
    */
   getPageIndex(ref) {
     return this._transport.getPageIndex(ref);