🤖 Merge PR DefinitelyTyped#72012 feat(node/stream/web): Add options to ReadableStreamBYOBReader.read() by @hkleungai

Author: hkleungai

types/node/stream/web.d.ts

@@ -205,7 +205,12 @@ declare module "stream/web" {
     /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBReader) */
     interface ReadableStreamBYOBReader extends ReadableStreamGenericReader {
         /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBReader/read) */
-        read<T extends ArrayBufferView>(view: T): Promise<ReadableStreamReadResult<T>>;
+        read<T extends ArrayBufferView>(
+            view: T,
+            options?: {
+                min?: number;
+            },
+        ): Promise<ReadableStreamReadResult<T>>;
         /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBReader/releaseLock) */
         releaseLock(): void;
     }

types/node/test/stream.ts

@@ -20,7 +20,7 @@ import { performance } from "node:perf_hooks";
 import { stdout } from "node:process";
 import { arrayBuffer, blob, buffer, json, text } from "node:stream/consumers";
 import { finished as finishedPromise, pipeline as pipelinePromise } from "node:stream/promises";
-import { ReadableStream, TransformStream, WritableStream } from "node:stream/web";
+import { ReadableStream, ReadableStreamBYOBReader, TransformStream, WritableStream } from "node:stream/web";
 import { setInterval as every, setTimeout as wait } from "node:timers/promises";
 import { MessageChannel as NodeMC } from "node:worker_threads";
 
@@ -810,5 +810,24 @@ async function testTransferringStreamWithPostMessage() {
 }
 
 {
-    new Blob(["1", "2"]).stream().getReader({ mode: "byob" });
+    let byobReader = new Blob(["1", "2"]).stream().getReader({ mode: "byob" });
+    byobReader = new ReadableStreamBYOBReader(new Blob([]).stream());
+
+    // $ExpectType Promise<void>
+    byobReader.cancel();
+    // $ExpectType Promise<void>
+    byobReader.cancel("reason");
+
+    // $ExpectType Promise<undefined>
+    byobReader.closed;
+
+    // $ExpectType Promise<ReadableStreamReadResult<Uint8Array<ArrayBuffer>>>
+    byobReader.read(new Uint8Array());
+    // $ExpectType Promise<ReadableStreamReadResult<Uint8Array<ArrayBuffer>>>
+    byobReader.read(new Uint8Array(), {});
+    // $ExpectType Promise<ReadableStreamReadResult<Uint8Array<ArrayBuffer>>>
+    byobReader.read(new Uint8Array(), { min: 1 });
+
+    // $ExpectType void
+    byobReader.releaseLock();
 }

types/node/v18/test/stream.ts

@@ -13,12 +13,13 @@ import {
 import { promisify } from "node:util";
 import { constants, createGzip } from "node:zlib";
 import assert = require("node:assert");
+import { Blob } from "node:buffer";
 import { Http2ServerResponse } from "node:http2";
 import { performance } from "node:perf_hooks";
 import { stdout } from "node:process";
 import { arrayBuffer, blob, buffer, json, text } from "node:stream/consumers";
 import { finished as finishedPromise, pipeline as pipelinePromise } from "node:stream/promises";
-import { ReadableStream, TransformStream, WritableStream } from "node:stream/web";
+import { ReadableStream, ReadableStreamBYOBReader, TransformStream, WritableStream } from "node:stream/web";
 import { setInterval as every } from "node:timers/promises";
 import { MessageChannel as NodeMC } from "node:worker_threads";
 
@@ -720,3 +721,22 @@ async function testTransferringStreamWithPostMessage() {
         err;
     });
 }
+
+{
+    let byobReader = new Blob(["1", "2"]).stream().getReader({ mode: "byob" });
+    byobReader = new ReadableStreamBYOBReader(new Blob([]).stream());
+
+    // $ExpectType Promise<void>
+    byobReader.cancel();
+    // $ExpectType Promise<void>
+    byobReader.cancel("reason");
+
+    // $ExpectType Promise<undefined>
+    byobReader.closed;
+
+    // $ExpectType Promise<ReadableStreamReadResult<Uint8Array<ArrayBuffer>>>
+    byobReader.read(new Uint8Array());
+
+    // $ExpectType void
+    byobReader.releaseLock();
+}

types/node/v20/stream/web.d.ts

@@ -205,7 +205,12 @@ declare module "stream/web" {
     /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBReader) */
     interface ReadableStreamBYOBReader extends ReadableStreamGenericReader {
         /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBReader/read) */
-        read<T extends ArrayBufferView>(view: T): Promise<ReadableStreamReadResult<T>>;
+        read<T extends ArrayBufferView>(
+            view: T,
+            options?: {
+                min?: number;
+            },
+        ): Promise<ReadableStreamReadResult<T>>;
         /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBReader/releaseLock) */
         releaseLock(): void;
     }

types/node/v20/test/stream.ts

@@ -20,7 +20,7 @@ import { performance } from "node:perf_hooks";
 import { stdout } from "node:process";
 import { arrayBuffer, blob, buffer, json, text } from "node:stream/consumers";
 import { finished as finishedPromise, pipeline as pipelinePromise } from "node:stream/promises";
-import { ReadableStream, TransformStream, WritableStream } from "node:stream/web";
+import { ReadableStream, ReadableStreamBYOBReader, TransformStream, WritableStream } from "node:stream/web";
 import { setInterval as every, setTimeout as wait } from "node:timers/promises";
 import { MessageChannel as NodeMC } from "node:worker_threads";
 
@@ -810,5 +810,24 @@ async function testTransferringStreamWithPostMessage() {
 }
 
 {
-    new Blob(["1", "2"]).stream().getReader({ mode: "byob" });
+    let byobReader = new Blob(["1", "2"]).stream().getReader({ mode: "byob" });
+    byobReader = new ReadableStreamBYOBReader(new Blob([]).stream());
+
+    // $ExpectType Promise<void>
+    byobReader.cancel();
+    // $ExpectType Promise<void>
+    byobReader.cancel("reason");
+
+    // $ExpectType Promise<undefined>
+    byobReader.closed;
+
+    // $ExpectType Promise<ReadableStreamReadResult<Uint8Array<ArrayBuffer>>>
+    byobReader.read(new Uint8Array());
+    // $ExpectType Promise<ReadableStreamReadResult<Uint8Array<ArrayBuffer>>>
+    byobReader.read(new Uint8Array(), {});
+    // $ExpectType Promise<ReadableStreamReadResult<Uint8Array<ArrayBuffer>>>
+    byobReader.read(new Uint8Array(), { min: 1 });
+
+    // $ExpectType void
+    byobReader.releaseLock();
 }