ReadableStreamDefaultReader: releaseLock() method
Baseline
Widely available
This feature is well established and works across many devices and browser versions. It’s been available across browsers since January 2020.
Note: This feature is available in Web Workers.
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.
If the reader's lock is released while it still has pending read requests then the promises returned by the reader's ReadableStreamDefaultReader.read() method are immediately rejected with a TypeError.
Unread chunks remain in the stream's internal queue and can be read later by acquiring a new reader.
Syntax
releaseLock()
Parameters
None.
Return value
None (undefined).
Exceptions
TypeError-
Thrown if the source object is not a
ReadableStreamDefaultReader.
Examples
function fetchStream() {
const reader = stream.getReader();
// …
reader.releaseLock();
// …
}
Specifications
| Specification |
|---|
| Streams # ref-for-default-reader-release-lock② |
Browser compatibility
| desktop | mobile | server | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
releaseLock
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
releaseLock() rejects pending read requests
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Legend
Tip: you can click/tap on a cell for more information.
- Full support
- Full support
- See implementation notes.
See also
ReadableStreamDefaultReader()constructor- Using readable streams