WritableStreamDefaultWriter.releaseLock()

This is an experimental technology
Check 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

writableStreamDefaultWriterInstance.releaseLock()

Parameters

None.

Return value

Void.

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

Browser compatibility

Update compatibility data on GitHub
DesktopMobile
ChromeEdgeFirefoxInternet ExplorerOperaSafariAndroid webviewChrome for AndroidEdge MobileFirefox for AndroidOpera for AndroidiOS SafariSamsung Internet
Basic support
Experimental
Chrome Full support 59Edge Full support 16Firefox No support NoIE No support NoOpera Full support 46Safari ? WebView Android Full support 59Chrome Android Full support 59Edge Mobile Full support 16Firefox Android No support NoOpera Android Full support 46Safari iOS ? Samsung Internet Android ?

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.

Document Tags and Contributors

Contributors to this page: connorshea, chrisdavidmills, abbycar, jpmedley
Last updated by: connorshea,