Web/API/WritableStreamDefaultWriter/releaseLock

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

Draft This page is not complete.

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	Status	Comment
StreamsThe definition of 'releaseLock()' in that specification.	Living Standard	Initial definition.

Browser compatibility

Update compatibility data on GitHub

	Desktop						Mobile
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari	Android webview	Chrome for Android	Firefox for Android	Opera for Android	Safari on iOS	Samsung Internet
`releaseLock` Experimental'	Chrome Full support 59	Edge Full support 16	Firefox No support No	IE No support No	Opera Full support 46	Safari ?	WebView Android Full support 59	Chrome Android Full support 59	Firefox Android No support No	Opera Android Full support 43	Safari iOS ?	Samsung Internet Android Full support 7.0

Legend

Full support: Full support
No support: No support
Compatibility unknown: Compatibility unknown
Experimental. Expect behavior to change in the future.': Experimental. Expect behavior to change in the future.

WritableStreamDefaultWriter.releaseLock() by Mozilla Contributors is licensed under CC-BY-SA 2.5.