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
readableStreamDefaultControllerInstance.error(e);
Parameters
- e
- The error you want future interactions to fail with.
Return value
Void.
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
The compatibility table on 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.
Update compatibility data on GitHub
| Desktop | Mobile | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Basic support | Chrome ? | Edge ? | Firefox ? | IE ? | Opera ? | Safari ? | WebView Android ? | Chrome Android ? | Edge Mobile ? | Firefox Android ? | Opera Android ? | Safari iOS ? | Samsung Internet Android ? |
Legend
- Compatibility unknown
- Compatibility unknown
- Experimental. Expect behavior to change in the future.
- Experimental. Expect behavior to change in the future.
Document Tags and Contributors
Tags:
Contributors to this page:
chrisdavidmills,
fscholz
Last updated by:
chrisdavidmills,