ReadableStreamBYOBReader.cancel()

Draft

This page is not complete.

Experimental

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

The cancel() method of the ReadableStreamBYOBReader interface returns a Promise that resolves when the stream is canceled. Calling this method signals a loss of interest in the stream by a consumer.

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

Syntax

var promise = readableStreamBYOBReader.cancel(reason);

Parameters

reason Optional
A human-readable reason for the cancellation. The underlying source may or may not use it.

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
Streams Standard (Streams)
# ref-for-generic-reader-cancel②

Browser compatibility

BCD tables only load in the browser