ReadableStreamDefaultController.error()

Draft
This page is not complete.

This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

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

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

No compatibility data found. Please contribute data for "path.to.feature.NameOfTheProperty" (depth: 1) to the MDN compatibility data repository.

Document Tags and Contributors

 Contributors to this page: chrisdavidmills
 Last updated by: chrisdavidmills,