ReadableStreamBYOBReader.ReadableStreamBYOBReader()

Draft
This page is not complete.

This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The ReadableStreamBYOBReader() constructor creates and returns a ReadableStreamBYOBReader() object instance.

Note: You generally wouldn't use this constructor manually; instead, you'd use the ReadableStream.getReader() method.

Syntax

var readableStreamReader = new ReadableStreamBYOBReader(stream);

Parameters

stream
The ReadableStream to be read.

Return value

An instance of the ReadableStreamBYOBReader object.

Exceptions

TypeError
The supplied stream parameter is not a ReadableStream, or it is already locked for reading by another reader, or its stream controller is not a ReadableByteStreamController.

Examples

TBD

Specifications

Specification Status Comment
Streams
The definition of 'ReadableStreamBYOBReader()' in that specification.
Living Standard Initial definition.

Browser compatibility

No compatibility data found. Please contribute data for "path.to.feature.NameOfTheConstructor" (depth: 1) to the MDN compatibility data repository.

Document Tags and Contributors

 Contributors to this page: chrisdavidmills
 Last updated by: chrisdavidmills,