ReadableStreamBYOBReader.read() - Web APIs 编辑

Draft

This page is not complete.

Experimental

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

The read() method of the ReadableStreamBYOBReader interface returns a promise providing access to the next chunk in the byte stream's internal queue.

Syntax

var promise = readableStreamBYOBReader.read(view);

Parameters

view

The view to be read into.

Return value

A Promise, which fulfills/rejects with a result depending on the state of the stream. The different possibilities are as follows:

• If a chunk is available, the promise will be fulfilled with an object of the form { value: theChunk, done: false }.
• If the stream becomes closed, the promise will be fulfilled with an object of the form { value: undefined, done: true }.
• If the stream becomes errored, the promise will be rejected with the relevant error.

Exceptions

TypeError

The source object is not a ReadableStreamBYOBReader, the stream has no owner, the view is not an object or has become detached, or the view's length is 0.

Examples

TBD.

Specifications

Browser compatibility

BCD tables only load in the browser

The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.