WritableStreamDefaultWriter: abort() method

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

The abort() method of the {{domxref("WritableStreamDefaultWriter")}} interface aborts the stream, signaling that the producer can no longer successfully write to the stream and it is to be immediately moved to an error state, with any queued writes discarded.

If the writer is active, the abort() method behaves the same as that for the associated stream ({{domxref("WritableStream.abort()")}}). If not, it returns a rejected promise.

Syntax

abort()
abort(reason)

Parameters

• reason {{optional_inline}}
  • : A string representing a human-readable reason for the abort.

Return value

A {{jsxref("Promise")}}, which fulfills to undefined when the stream is aborted, or rejects with an error if the writer was inactive or the receiver stream is invalid.

Exceptions

• {{jsxref("TypeError")}}
  • : The stream you are trying to abort is not a {{domxref("WritableStream")}}, or it is locked.

Examples

const writableStream = new WritableStream(
  {
    write(chunk) {
      // …
    },
    close() {
      // …
    },
    abort(err) {
      // …
    },
  },
  queuingStrategy,
);

// …

const writer = writableStream.getWriter();

// …

// abort the stream when desired
await writer.abort("WritableStream aborted. Reason: ...");

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}