W3cubDocs

/Web APIs

ReadableStreamDefaultReader.releaseLock()

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

releaseLock()

Parameters

None.

Return value

undefined.

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
Streams Standard
# ref-for-default-reader-release-lock②

Browser compatibility

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
releaseLock
78
79
65
No
65
No
78
78
65
56
No
12.0

© 2005–2021 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/ReadableStreamDefaultReader/releaseLock