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()
).
A Promise
, which fulfills with the value given in the reason
parameter.
This example code calls the cancel()
method when a button is pressed, passing the string "user choice" as a reason. The promise resolves when cancellation completes.
button.addEventListener("click", () => {
reader.cancel("user choice").then(() => console.log(`cancel complete`));
});
Note that this code can be seen running in the Using readable byte streams example code (press the Cancel stream button).