Back to Content

ReadableStreamDefaultReader: closed property

files/en-us/web/api/readablestreamdefaultreader/closed/index.md

latest967 B
Original Source

{{APIRef("Streams")}}{{AvailableInWorkers}}

The closed read-only property of the {{domxref("ReadableStreamDefaultReader")}} interface returns a {{jsxref("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 {{jsxref("Promise")}}.

Examples

In this snippet, a previously-created reader is queried to see if the stream has been closed. When it is closed, the promise fulfills and the message is logged to the console.

js
reader.closed.then(() => {
  console.log("reader closed");
});

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also

  • {{domxref("ReadableStreamDefaultReader.ReadableStreamDefaultReader", "ReadableStreamDefaultReader()")}} constructor
  • Using readable streams