ReadableStreamBYOBReader: closed property

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

The closed read-only property of the {{domxref("ReadableStreamBYOBReader")}} 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

The code below shows the pattern for handling the closed/error state of a BYOBReader.

const reader = stream.getReader({ mode: "byob" });
reader.closed
  .then(() => {
    // Resolved - code to handle stream closing
  })
  .catch(() => {
    // Rejected - code to handle error
  });

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also

• {{domxref("ReadableStreamBYOBReader.ReadableStreamBYOBReader", "ReadableStreamBYOBReader()")}} constructor
• Using readable byte stream