From 70c79c6f69139fe00677777eb0233f79c33cdd84 Mon Sep 17 00:00:00 2001
From: Jonas Jenwald <jonas.jenwald@gmail.com>
Date: Thu, 27 May 2021 16:41:08 +0200
Subject: [PATCH] Fix the JSDocs for `PDFDocumentProxy.getPageIndex` (issue
 13449)

---
 src/display/api.js | 14 +++++++++-----
 1 file changed, 9 insertions(+), 5 deletions(-)

diff --git a/src/display/api.js b/src/display/api.js
index ce7bac9d1..015a526dc 100644
--- 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);