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 ReadableStreamBYOBReader
interface releases the reader's lock on the stream. After the lock is released, the reader is no longer active.
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 ReadableStreamBYOBReader.read()
method has not finished. This will result in a TypeError
being thrown.
Syntax
readableStreamBYOBReader.releaseLock();
Parameters
None.
Return value
undefined
.
Exceptions
- TypeError
- The source object is not a
ReadableStreamBYOBReader
, or a read request is pending.
Examples
TBD.
Specifications
Specification | Status | Comment |
---|---|---|
Streams The definition of 'releaseLock()' in that specification. |
Living Standard | Initial definition. |
Browser compatibility
The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
releaseLock | Chrome No support No | Edge No support No | Firefox No support No | IE No support No | Opera No support No | Safari No support No | WebView Android No support No | Chrome Android No support No | Firefox Android No support No | Opera Android No support No | Safari iOS No support No | Samsung Internet Android No support No |
Legend
- No support
- No support
- Experimental. Expect behavior to change in the future.
- Experimental. Expect behavior to change in the future.