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 cancels the stream, signaling a loss
of interest in the stream by a consumer. The supplied reason
parameter 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
var promise = readableStreamBYOBReader.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
BCD tables only load in the browser
The compatibility table in 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.