ReadableStreamDefaultController: error() method
Baseline
Widely available
This feature is well established and works across many devices and browser versions. It’s been available across browsers since January 2020.
Note: This feature is available in Web Workers.
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
error(e)
Parameters
e-
The error you want future interactions to fail with.
Return value
None (undefined).
Exceptions
TypeError-
Thrown if the source object is not a
ReadableStreamDefaultController.
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 |
|---|
| Streams # rs-default-controller-error |