feat(node/stream): add 2nd options param to Readable.toWeb() (DefinitelyTyped#71851)

Author: hkleungai

types/node/stream.d.ts

@@ -981,7 +981,12 @@ declare module "stream" {
              * @since v17.0.0
              * @experimental
              */
-            static toWeb(streamReadable: Readable): streamWeb.ReadableStream;
+            static toWeb(
+                streamReadable: Readable,
+                options?: {
+                    strategy?: streamWeb.QueuingStrategy | undefined;
+                },
+            ): streamWeb.ReadableStream;
         }
         interface WritableOptions extends StreamOptions<Writable> {
             decodeStrings?: boolean | undefined;

types/node/test/stream.ts

@@ -584,8 +584,29 @@ addAbortSignal(new AbortSignal(), new Readable());
 
 {
     const readable = new Readable();
+
     // $ExpectType ReadableStream<any>
     Readable.toWeb(readable);
+
+    // $ExpectType ReadableStream<any>
+    Readable.toWeb(readable, {});
+
+    // $ExpectType ReadableStream<any>
+    Readable.toWeb(readable, { strategy: {} });
+
+    // $ExpectType ReadableStream<any>
+    Readable.toWeb(readable, {
+        strategy: {
+            highWaterMark: 3,
+
+            size(chunk) {
+                // $ExpectType any
+                chunk;
+
+                return -1;
+            },
+        },
+    });
 }
 
 {

types/node/v18/stream.d.ts

@@ -86,7 +86,12 @@ declare module "stream" {
              * @since v17.0.0
              * @experimental
              */
-            static toWeb(streamReadable: Readable): streamWeb.ReadableStream;
+            static toWeb(
+                streamReadable: Readable,
+                options?: {
+                    strategy?: streamWeb.QueuingStrategy | undefined;
+                },
+            ): streamWeb.ReadableStream;
             /**
              * Returns whether the stream was destroyed or errored before emitting `'end'`.
              * @since v16.8.0

types/node/v18/test/stream.ts

@@ -571,8 +571,29 @@ addAbortSignal(new AbortSignal(), new Readable());
 
 {
     const readable = new Readable();
+
     // $ExpectType ReadableStream<any>
     Readable.toWeb(readable);
+
+    // $ExpectType ReadableStream<any>
+    Readable.toWeb(readable, {});
+
+    // $ExpectType ReadableStream<any>
+    Readable.toWeb(readable, { strategy: {} });
+
+    // $ExpectType ReadableStream<any>
+    Readable.toWeb(readable, {
+        strategy: {
+            highWaterMark: 3,
+
+            size(chunk) {
+                // $ExpectType any
+                chunk;
+
+                return -1;
+            },
+        },
+    });
 }
 
 {

types/node/v20/stream.d.ts

@@ -981,7 +981,12 @@ declare module "stream" {
              * @since v17.0.0
              * @experimental
              */
-            static toWeb(streamReadable: Readable): streamWeb.ReadableStream;
+            static toWeb(
+                streamReadable: Readable,
+                options?: {
+                    strategy?: streamWeb.QueuingStrategy | undefined;
+                },
+            ): streamWeb.ReadableStream;
         }
         interface WritableOptions extends StreamOptions<Writable> {
             decodeStrings?: boolean | undefined;

types/node/v20/test/stream.ts

@@ -584,8 +584,29 @@ addAbortSignal(new AbortSignal(), new Readable());
 
 {
     const readable = new Readable();
+
     // $ExpectType ReadableStream<any>
     Readable.toWeb(readable);
+
+    // $ExpectType ReadableStream<any>
+    Readable.toWeb(readable, {});
+
+    // $ExpectType ReadableStream<any>
+    Readable.toWeb(readable, { strategy: {} });
+
+    // $ExpectType ReadableStream<any>
+    Readable.toWeb(readable, {
+        strategy: {
+            highWaterMark: 3,
+
+            size(chunk) {
+                // $ExpectType any
+                chunk;
+
+                return -1;
+            },
+        },
+    });
 }
 
 {