WritableStreamDefaultWriter: releaseLock() method

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

The releaseLock() method of the {{domxref("WritableStreamDefaultWriter")}} interface releases the writer's lock on the corresponding stream. After the lock is released, the writer is no longer active. If the associated stream is errored when the lock is released, the writer will appear errored in the same way from now on; otherwise, the writer will appear closed.

Syntax

releaseLock()

Parameters

None.

Return value

None ({{jsxref("undefined")}}).

Examples

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

// …

const writer = writableStream.getWriter();

// …

// release writer's lock on the stream when desired
writer.releaseLock();

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}