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()
).
Promise<reason> readableStreamBYOBReaderInstance.cancel(reason);
DOMString
providing a human-readable reason for the cancellation.A Promise
, which fulfills with the value given in the reason
parameter.
ReadableStreamBYOBReader
, or the stream has no owner.TBD.
Specification | Status | Comment |
---|---|---|
Streams The definition of 'cancel()' in that specification. | Living Standard | Initial definition. |
Desktop | ||||||
---|---|---|---|---|---|---|
Chrome | Edge | Firefox | Internet Explorer | Opera | Safari | |
Basic support | No | No | No | No | No | No |
Mobile | |||||||
---|---|---|---|---|---|---|---|
Android webview | Chrome for Android | Edge Mobile | Firefox for Android | Opera for Android | iOS Safari | Samsung Internet | |
Basic support | No | No | No | No | No | No | ? |
© 2005–2018 Mozilla Developer Network and individual contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/ReadableStreamBYOBReader/cancel