Skip to main content

ReadableStreamDefaultReader

The ReadableStreamDefaultReader interface of the Streams API represents a default reader that can be used to read stream data supplied from a network (such as a fetch request).

MDN Reference

Extends​

Type Parameters​

Type ParameterDefault type
Rany

Methods​

cancel()​

cancel(reason?): Promise<void>;

MDN Reference

Parameters​

ParameterType
reason?any

Returns​

Promise<void>

Inherited from​

ReadableStreamGenericReader.cancel


read()​

read(): Promise<ReadableStreamReadResult<R>>;

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

MDN Reference

Returns​

Promise<ReadableStreamReadResult<R>>


releaseLock()​

releaseLock(): void;

The releaseLock() method of the ReadableStreamDefaultReader interface releases the reader's lock on the stream.

MDN Reference

Returns​

void

Properties​

closed​

readonly closed: Promise<void>;

MDN Reference

Inherited from​

ReadableStreamGenericReader.closed