Package-level declarations
Types
The ByteLengthQueuingStrategy
interface of the Streams API provides a built-in byte length queuing strategy that can be used when constructing streams.
The CountQueuingStrategy
interface of the Streams API provides a built-in chunk counting queuing strategy that can be used when constructing streams.
The ReadableByteStreamController
interface of the Streams API represents a controller for a readable byte stream.
The ReadableStream
interface of the Streams API represents a readable stream of byte data.
The ReadableStreamBYOBReader
interface of the Streams API defines a reader for a ReadableStream that supports zero-copy reading from an underlying byte source.
The ReadableStreamBYOBRequest
interface of the Streams API represents a 'pull request' for data from an underlying source that will made as a zero-copy transfer to a consumer (bypassing the stream's internal queues).
Union of:
The ReadableStreamDefaultController
interface of the Streams API represents a controller allowing control of a ReadableStream's state and internal queue.
The ReadableStreamDefaultReader
interface of the Streams API represents a default reader that can be used to read stream data supplied from a network (such as a fetch request).
The TransformStream
interface of the Streams API represents a concrete implementation of the pipe chain transform stream concept.
The TransformStreamDefaultController
interface of the Streams API provides methods to manipulate the associated ReadableStream and WritableStream.
The WritableStream
interface of the Streams API provides a standard abstraction for writing streaming data to a destination, known as a sink.
The WritableStreamDefaultController
interface of the Streams API represents a controller allowing control of a WritableStream's state.
The WritableStreamDefaultWriter
interface of the Streams API is the object returned by WritableStream.getWriter() and once created locks the writer to the WritableStream
ensuring that no other streams can write to the underlying sink.
Functions
The abort()
method of the WritableStreamDefaultWriter interface aborts the stream, signaling that the producer can no longer successfully write to the stream and it is to be immediately moved to an error state, with any queued writes discarded.
The abort()
method of the WritableStream interface aborts the stream, signaling that the producer can no longer successfully write to the stream and it is to be immediately moved to an error state, with any queued writes discarded.
The cancel()
method of the ReadableStream interface returns a Promise that resolves when the stream is canceled.
The close()
method of the WritableStreamDefaultWriter interface closes the associated writable stream.
The close()
method of the WritableStream interface closes the associated stream.
The pipeTo()
method of the ReadableStream interface pipes the current ReadableStream
to a given WritableStream and returns a Promise that fulfills when the piping process completes successfully, or rejects if any errors were encountered.
The read()
method of the ReadableStreamDefaultReader interface returns a Promise providing access to the next chunk in the stream's internal queue.
The read()
method of the ReadableStreamBYOBReader interface is used to read data into a view on a user-supplied buffer from an associated readable byte stream.
The write()
method of the WritableStreamDefaultWriter interface writes a passed chunk of data to a WritableStream and its underlying sink, then returns a Promise that resolves to indicate the success or failure of the write operation.