Streams
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.
The reader will appear errored if the associated stream is errored when the lock is released; 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 ReadableStreamBYOBReader.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
ReadableStreamBYOBReader.
- : Thrown if the source object is not a
Examples
A trivial examples is shown below. A lock is created as soon as the reader is created on the stream.
const reader = stream.getReader({ mode: "byob" });
reader.releaseLock();
Specifications
Browser compatibility
See also
- ReadableStreamBYOBReader.ReadableStreamBYOBReader constructor
- Using readable byte stream
来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。
