chore: add ContentHandle.read doc

fleek-network · May 29, 2024 · 6e19755 · 6e19755
1 parent 969d0f2
commit 6e19755
Showing 1 changed file with 7 additions and 2 deletions.
diff --git a/dts/lib.fleek.d.ts b/dts/lib.fleek.d.ts
@@ -1,14 +1,19 @@
 /** Handle to blockstore content.
  * Utility for traversing the proof and reading blocks from the blockstore.
- * @property {Uint8Array} proof - Blake3 proof of the content
+ * @property {Uint8Array} proof - Raw blake3 proof of the content
  * @property {number} length - Number of blocks in the content
  * @category Fleek APIs
  */
 declare class ContentHandle {
   constructor(proof: Uint8Array);
   proof: Uint8Array;
   length: number;
-  read(id: any): any;
+  /**
+    * Read a given block index from the blockstore
+    * @param {number} idx - Index of block to read
+    * @returns {Promise<Uint8Array>}
+    */
+  read(idx: number): Promise<Uint8Array>;
 }
 
 /** @category Fleek APIs */