Interface ByteStream<S>

interface ByteStream<S extends MessageStream> {
    read(
        options: ReadBytesOptions,
    ): Promise<Uint8ArrayList<ArrayBufferLike>>;
    read(
        options?: AbortOptions,
    ): Promise<Uint8ArrayList<ArrayBufferLike> | null>;
    unwrap(): S;
    write(
        data: Uint8Array<ArrayBufferLike> | Uint8ArrayList<ArrayBufferLike>,
        options?: AbortOptions,
    ): Promise<void>;
}

Type Parameters

S extends MessageStream

Index

Methods

read unwrap write

Methods

read

read(options: ReadBytesOptions): Promise<Uint8ArrayList<ArrayBufferLike>>
Read bytes from the stream.

If a required number of bytes is passed as an option, this will wait for the underlying stream to supply that number of bytes, throwing an UnexpectedEOFError if the stream closes before this happens.

If no required number of bytes is passed, this will return null if the underlying stream closes before supplying any bytes.
Parameters
- options: ReadBytesOptions
Returns Promise<Uint8ArrayList<ArrayBufferLike>>
- Defined in packages/utils/src/stream-utils.ts:73
read(options?: AbortOptions): Promise<Uint8ArrayList<ArrayBufferLike> | null>
Parameters
- Optionaloptions: AbortOptions
Returns Promise<Uint8ArrayList<ArrayBufferLike> | null>
- Defined in packages/utils/src/stream-utils.ts:74

unwrap

unwrap(): S
After calling this method the stream can no longer be used. Any unread data will be emitted as a message event during the microtask queue of the current event loop tick.

Returns S
- Defined in packages/utils/src/stream-utils.ts:86

write

write(
data: Uint8Array<ArrayBufferLike> | Uint8ArrayList<ArrayBufferLike>,
options?: AbortOptions,
): Promise<void>
Write the passed bytes to the stream
Parameters
- data: Uint8Array<ArrayBufferLike> | Uint8ArrayList<ArrayBufferLike>
- Optionaloptions: AbortOptions
Returns Promise<void>
- Defined in packages/utils/src/stream-utils.ts:79