ReadableStreamDefaultController.error()

The error() method of the ReadableStreamDefaultController interface causes any future interactions with the associated stream to error.

Note: The error() method can be called more than once, and can be called when the stream is not readable.

Syntax

readableStreamDefaultController.error(e);

Parameters

e
The error you want future interactions to fail with.

Return value

undefined.

Exceptions

TypeError
The source object is not a ReadableStreamDefaultController, or the stream is not readable for some other reason.

Examples

The A readable stream with an underlying push source and backpressure support example in the spec provides a good example of using ReadablestreamDefaultController.desiredSize to manually detect when the stream is full and apply backpressure, and also of using error() to manually trigger a stream error if another part of the system it relies on fails.

Specifications

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

Browser compatibility

BCD tables only load in the browser