web api instance method
ReadableStreamDefaultController: error() method
Available in 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.
- : Thrown if the source object is not a
Examples
The A readable stream with an underlying push source and backpressure support example in the spec
provides a good example of using
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
SpecificationsStandards references are available on the canonical MDN page.
Browser compatibility
Browser compatibilityCompatibility data is available on the canonical MDN page.