The cancel() method of the ReadableStreamDefaultReader 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.
Cancel is used when you've completely finished with the stream and don't need any more data from it, even if there are chunks enqueued waiting to be read. That data is lost after cancel is called, and the stream is not readable any more. To read those chunks still and not completely get rid of the stream, you'd use ReadableStreamDefaultController.close().
Note: If the reader is active, the cancel() method behaves the same as that for the associated stream (ReadableStream.cancel()).
Syntax
var promise = readableStreamDefaultReader.cancel(reason);
Parameters
- reason Optional
- A
DOMStringproviding 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
ReadableStreamDefaultReader, or the stream has no owner.
Examples
In the following simple example, a previously-created custom ReadableStream is read using a ReadableStreamDefaultReader created using getReader(). (this code is based on our [[../../../../../../../mdn.github.io/dom-examples/streams/simple-random-stream/index|Simple random stream example]]). Each chunk is read sequentially and output to the UI, until the stream has finished being read, at which point we return out of the recursive function and print the entire stream to another part of the UI.
When the stream is done (if (done)), we run reader.cancel() to cancel the stream, signalling that we don't need to use it any more.
function fetchStream() {
const reader = stream.getReader();
let charsReceived = 0;
// read() returns a promise that resolves
// when a value has been received
reader.read().then(function processText({ done, value }) {
// Result objects contain two properties:
// done - true if the stream has already given you all its data.
// value - some data. Always undefined when done is true.
if (done) {
console.log("Stream complete");
reader.cancel();
para.textContent = result;
return;
}
// value for fetch streams is a Uint8Array
charsReceived += value.length;
const chunk = value;
let listItem = document.createElement('li');
listItem.textContent = 'Received ' + charsReceived + ' characters so far. Current chunk = ' + chunk;
list2.appendChild(listItem);
result += chunk;
// Read some more, and call this function again
return reader.read().then(processText);
});
}Specifications
| Specification | Status | Comment |
| StreamsThe definition of 'cancel()' in that specification. | Living Standard | Initial definition. |
Browser compatibility
The compatibility table on 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.
Update compatibility data on GitHub
| Desktop | Mobile | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
Chrome
? |
Edge
? |
Firefox Full support 65 Full support 65 Full support 57 Disabled' From version 57: this feature is behind the |
IE
No support No |
Opera
? |
Safari
? |
WebView Android
? |
Chrome Android
? |
Firefox Android Full support 65 Full support 65 Full support 57 Disabled' From version 57: this feature is behind the |
Opera Android
? |
Safari iOS
? |
Samsung Internet Android
? |
Legend
- Full support
- Full support
- No support
- No support
- Compatibility unknown
- Compatibility unknown
- Experimental. Expect behavior to change in the future.'
- Experimental. Expect behavior to change in the future.
- User must explicitly enable this feature.'
- User must explicitly enable this feature.
ReadableStreamDefaultReader.cancel() by Mozilla Contributors is licensed under CC-BY-SA 2.5.
