ReadableStreamBYOBReader.cancel()

Draft
This page is not complete.

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

The cancel() method of the ReadableStreamBYOBReader interface cancels the stream, signaling a loss of interest in the stream by a consumer. The supplied reason argument will be given to the underlying source, which may or may not use it.

Note: If the reader is active, the cancel() method behaves the same as that for the associated stream (ReadableStream.cancel()).

Syntax

Promise<reason> readableStreamBYOBReaderInstance.cancel(reason);

Parameters

reason
A DOMString providing a human-readable reason for the cancellation.

Return value

A Promise, which fulfills with the value given in the reason parameter.

Exceptions

TypeError
The source object is not a ReadableStreamBYOBReader, or the stream has no owner.

Examples

TBD.

Specifications

Specification Status Comment
Streams
The definition of 'cancel()' 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,