Constructor

None. ReadableStreamBYOBRequest instance is created automatically by ReadableByteStreamController as needed.

Instance properties

ReadableStreamBYOBRequest.view Read only

Returns the current view. This is a view on a buffer that will be transferred to the consumer when ReadableStreamBYOBRequest.respond() is called.

Instance methods

ReadableStreamBYOBRequest.respond()

Signals the associated readable byte stream that the specified number of bytes were written into the current view, which then causes the pending request from the consumer to be resolved. Note that after this method is called the view is transferred and no longer modifiable.

ReadableStreamBYOBRequest.respondWithNewView()

Signals to the associated readable byte stream view passed as an argument should be transferred to the consumer of the readable byte stream. This new view must use the same buffer as the original view, start at the same offset, and be the same length or shorter. Note that after this method is called the view is transferred and no longer modifiable.

Examples

The following code is taken from the live example in Using readable byte streams > Creating a readable socket push byte stream.

A push underlying byte source with data to transfer should first check that controller.byobRequest is non-null. Pul A pull underlying byte source would only need this check if auto chunk allocation was not enabled and it was used with a default reader.

if (controller.byobRequest) {
  /* code to transfer data */
}

There are two ways to read data into a ReadableStreamBYOBRequest and then transfer it. The first is to write the data into the ReadableStreamBYOBRequest.view property and then call ReadableStreamBYOBRequest.respond() to indicate the amount of data to be transferred. After the operation the byobRequest.view is detached and the request should be discarded.

The code below shows this case using a hypothetical readInto() method to copy data into the view:

const v = controller.byobRequest.view;
bytesRead = socket.readInto(v.buffer, v.byteOffset, v.byteLength);
controller.byobRequest.respond(bytesRead);

The other approach is to call ReadableStreamBYOBRequest.respondWithNewView() passing your own view on the same underlying backing data. Note that this just another way of specifying the range of the underlying buffer/memory backing that is actually transferred. The respondWithNewView equivalent to the code above would be:

const v = controller.byobRequest.view;
bytesRead = socket.readInto(v.buffer, v.byteOffset, v.byteLength);
const newView = new Uint8Array(v.buffer, v.byteOffset, bytesRead);
controller.byobRequest.respondWithNewView(newView);

Specifications

Browser compatibility

See also

• Using readable byte stream