ReadableStreamBYOBReader.releaseLock()
Experimental: 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 |
|---|
| Streams Standard # ref-for-byob-reader-release-lock② |
Browser compatibility
BCD tables only load in the browser