fix(bindings/nodejs): add type annotation for stream (#539)

databendlabs · Dec 17, 2024 · 2c5e085 · 2c5e085
1 parent 460890c
commit 2c5e085
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/bindings/nodejs/index.d.ts b/bindings/nodejs/index.d.ts
@@ -72,6 +72,11 @@ export declare class RowIterator {
    * Returns `None` if there are no more rows.
    */
   next(): Promise<Error | Row | null>
+  /**
+   * Return a Readable Stream for the query result.
+   * Should be used with `ObjectMode` set to `true`.
+   */
+  stream(): import('stream').Readable
 }
 export declare class RowIteratorExt {
   schema(): Schema

diff --git a/bindings/nodejs/src/lib.rs b/bindings/nodejs/src/lib.rs
@@ -365,6 +365,13 @@ impl RowIterator {
                 .map_err(format_napi_error)
         })
     }
+
+    /// Return a Readable Stream for the query result.
+    /// Should be used with `ObjectMode` set to `true`.
+    #[napi(ts_return_type = "import('stream').Readable")]
+    pub fn stream(&self) -> () {
+        unreachable!()
+    }
 }
 
 #[napi]