🤖 Merge PR DefinitelyTyped#74422 [node/stream/web] Fix type of byobRequest by @ikeyan

Author: ikeyan

types/node/node-tests/stream.ts

@@ -816,6 +816,23 @@ async function testTransferringStreamWithPostMessage() {
     byobReader.releaseLock();
 }
 
+{
+    const stream = new ReadableStream({
+        type: "bytes",
+        pull(controller) {
+            const req = controller.byobRequest;
+            if (!req?.view) return;
+            (req.view as Uint8Array).set([42], 0);
+            req.respond(1);
+            controller.close();
+        },
+    });
+    const reader = stream.getReader({ mode: "byob" });
+    reader.read(new Uint8Array(new ArrayBuffer(8))).then(({ done, value }) => {
+        console.log(done, value);
+    });
+}
+
 async function testStreamComposeExample1() {
     const removeSpaces = new Transform({
         transform(chunk, encoding, callback) {

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

@@ -238,7 +238,7 @@ declare module "stream/web" {
         new(): ReadableStreamBYOBRequest;
     };
     interface ReadableByteStreamController {
-        readonly byobRequest: undefined;
+        readonly byobRequest: ReadableStreamBYOBRequest | null;
         readonly desiredSize: number | null;
         close(): void;
         enqueue(chunk: ArrayBufferView): void;

types/node/v20/test/stream.ts

@@ -824,3 +824,20 @@ async function testTransferringStreamWithPostMessage() {
     // $ExpectType void
     byobReader.releaseLock();
 }
+
+{
+    const stream = new ReadableStream({
+        type: "bytes",
+        pull(controller) {
+            const req = controller.byobRequest;
+            if (!req?.view) return;
+            (req.view as Uint8Array).set([42], 0);
+            req.respond(1);
+            controller.close();
+        },
+    });
+    const reader = stream.getReader({ mode: "byob" });
+    reader.read(new Uint8Array(new ArrayBuffer(8))).then(({ done, value }) => {
+        console.log(done, value);
+    });
+}

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

@@ -241,7 +241,7 @@ declare module "stream/web" {
         new(): ReadableStreamBYOBRequest;
     };
     interface ReadableByteStreamController {
-        readonly byobRequest: undefined;
+        readonly byobRequest: ReadableStreamBYOBRequest | null;
         readonly desiredSize: number | null;
         close(): void;
         enqueue(chunk: ArrayBufferView): void;

types/node/v22/test/stream.ts

@@ -828,3 +828,20 @@ async function testTransferringStreamWithPostMessage() {
     // $ExpectType void
     byobReader.releaseLock();
 }
+
+{
+    const stream = new ReadableStream({
+        type: "bytes",
+        pull(controller) {
+            const req = controller.byobRequest;
+            if (!req?.view) return;
+            (req.view as Uint8Array).set([42], 0);
+            req.respond(1);
+            controller.close();
+        },
+    });
+    const reader = stream.getReader({ mode: "byob" });
+    reader.read(new Uint8Array(new ArrayBuffer(8))).then(({ done, value }) => {
+        console.log(done, value);
+    });
+}

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

@@ -237,7 +237,7 @@ declare module "stream/web" {
         new(): ReadableStreamBYOBRequest;
     };
     interface ReadableByteStreamController {
-        readonly byobRequest: undefined;
+        readonly byobRequest: ReadableStreamBYOBRequest | null;
         readonly desiredSize: number | null;
         close(): void;
         enqueue(chunk: ArrayBufferView): void;

types/node/v24/test/stream.ts

@@ -831,3 +831,20 @@ async function testTransferringStreamWithPostMessage() {
     // $ExpectType void
     byobReader.releaseLock();
 }
+
+{
+    const stream = new ReadableStream({
+        type: "bytes",
+        pull(controller) {
+            const req = controller.byobRequest;
+            if (!req?.view) return;
+            (req.view as Uint8Array).set([42], 0);
+            req.respond(1);
+            controller.close();
+        },
+    });
+    const reader = stream.getReader({ mode: "byob" });
+    reader.read(new Uint8Array(new ArrayBuffer(8))).then(({ done, value }) => {
+        console.log(done, value);
+    });
+}