ReadableStreamBYOBReader: closed property
Limited availability
This feature is not Baseline because it does not work in some of the most widely-used browsers.
Note: This feature is available in Web Workers.
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 # ref-for-generic-reader-closed② |
Browser compatibility
Report problems with this compatibility data on GitHubdesktop | mobile | server | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
closed |
Legend
Tip: you can click/tap on a cell for more information.
- Full support
- Full support
- No support
- No support
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.
See also
ReadableStreamBYOBReader()
constructor- Using readable byte stream