Streams
The close() method of the ReadableByteStreamController interface closes the associated stream.
This might be called by the underlying source when its data source has been exhausted/completed.
[!NOTE] Readers will still be able to read any previously-enqueued chunks from the stream, but once those are read, the stream will become closed. However if there is an outstanding and partially written ReadableByteStreamController.byobRequest when
close()is called, the stream will be errored.
Syntax
close()
Parameters
None.
Return value
None (undefined).
Exceptions
- TypeError
- : Thrown if the source object is not a
ReadableByteStreamController, it is already closed, or the stream is not readable for some other reason.
- : Thrown if the source object is not a
Examples
The example in Using readable byte streams > Creating a readable socket push byte stream how we might close the stream when there is no more data.
The relevant code is reproduced below.
This relies on the hypothetical readInto() method returning 0 bytes only when there is no more data.
bytesRead = socket.readInto(v.buffer, v.byteOffset, v.byteLength);
if (bytesRead === 0) {
controller.close();
}
After calling close, the stream will be closed, and any consumers signaled.
For example if using a ReadableStreamBYOBReader any ReadableStreamBYOBReader.read() requests would resolve with done: true and the promise from ReadableStreamBYOBReader.closed would also be resolved.
Specifications
Browser compatibility
See also
- Using readable byte streams
- ReadableByteStreamController
来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。
