ReadableStreamBYOBReader: closed property
The closed
read-only property of the ReadableStreamBYOBReader
interface returns a Promise
that fulfills when the stream closes, or rejects if the stream throws an error or the reader's lock is released.
This property enables you to write code that responds to an end to the streaming process.
Value
A Promise
.
Examples
The code below shows the pattern for handling the closed/error state of a BYOBReader.
js
const reader = stream.getReader({ mode: "byob" });
reader.closed
.then(() => {
// Resolved - code to handle stream closing
})
.catch(() => {
// Rejected - code to handle error
});
Specifications
Specification |
---|
Streams Standard # ref-for-generic-reader-closed② |
Browser compatibility
BCD tables only load in the browser
See also
ReadableStreamBYOBReader()
constructor- Using readable byte stream