add readFields type overload

mapbox · Aug 20, 2024 · a9d0a8d · a9d0a8d
1 parent 5e17dd5
commit a9d0a8d
Showing 1 changed file with 19 additions and 0 deletions.
diff --git a/index.js b/index.js
@@ -26,11 +26,30 @@ export default class Pbf {
 
     // === READING =================================================================
 
+    /**
+     * @template {string | number} K, V
+     * @overload
+     * @param {(tag: number, result: {key: K, value: V}, pbf: Pbf) => void} readField
+     * @param {{key: K, value: V}} result
+     * @param {number} [end]
+     * @returns {Record<K, V>}
+     */
+
+    /**
+     * @template T
+     * @overload
+     * @param {(tag: number, result: T, pbf: Pbf) => void} readField
+     * @param {T} result
+     * @param {number} [end]
+     * @returns {T}
+     */
+
     /**
      * @template T
      * @param {(tag: number, result: T, pbf: Pbf) => void} readField
      * @param {T} result
      * @param {number} [end]
+     * @returns {T}
      */
     readFields(readField, result, end = this.length) {
         while (this.pos < end) {