ReadableStreamDefaultReader.releaseLock()

Draft
This page is not complete.

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

The releaseLock() method of the ReadableStreamDefaultReader interface releases the reader's lock on the stream.

If the associated stream is errored when the lock is released, the reader will appear errored in that same way subsequently; otherwise, the reader will appear closed.

A reader’s lock cannot be released while it still has a pending read request, i.e., if a promise returned by the reader’s ReadableStreamDefaultReader.read() method has not finished. This will result in a TypeError being thrown.

Syntax

readableStreamDefaultReaderInstance.releaseLock();

Parameters

None.

Return value

Void.

Exceptions

TypeError
The source object is not a ReadableStreamDefaultReader, or a read request is pending.

Examples

function fetchStream() {
  const reader = stream.getReader();
  
  ...

  reader.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 AndroidSafari on iOSSamsung Internet
Basic support
Experimental
Chrome ? Edge ? Firefox ? IE ? Opera ? Safari ? WebView Android ? Chrome Android ? Edge Mobile ? Firefox Android ? Opera Android ? Safari iOS ? Samsung Internet Android ?

Legend

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: fscholz, chrisdavidmills
Last updated by: fscholz,