WritableStreamDefaultWriter.releaseLock()

Experimental

This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The releaseLock() method of the 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

writableStreamDefaultWritere.releaseLock()

Parameters

None.

Return value

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

Specification
Streams Standard (Streams)
# ref-for-default-writer-release-lock②

Browser compatibility

BCD tables only load in the browser