Interface LengthPrefixedStream<S>

interface LengthPrefixedStream<S extends MessageStream = MessageStream> {
    read(options?: AbortOptions): Promise<Uint8ArrayList>;
    unwrap(): S;
    write(
        data: Uint8Array<ArrayBufferLike> | Uint8ArrayList,
        options?: AbortOptions,
    ): Promise<void>;
    writeV(
        input: (Uint8Array<ArrayBufferLike> | Uint8ArrayList)[],
        options?: AbortOptions,
    ): Promise<void>;
}

Type Parameters

S extends MessageStream = MessageStream

Index

Methods

read unwrap write writeV

Methods

read

read(options?: AbortOptions): Promise<Uint8ArrayList>
Read the next length-prefixed number of bytes from the stream
Parameters
- Optionaloptions: AbortOptions
Returns Promise<Uint8ArrayList>
- Defined in packages/utils/src/stream-utils.ts:256

unwrap

unwrap(): S
Returns the underlying stream

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

write

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

writeV

writeV(
input: (Uint8Array<ArrayBufferLike> | Uint8ArrayList)[],
options?: AbortOptions,
): Promise<void>
Write passed list of bytes, prefix by their individual lengths to the stream as a single write
Parameters
- input: (Uint8Array<ArrayBufferLike> | Uint8ArrayList)[]
- Optionaloptions: AbortOptions
Returns Promise<void>
- Defined in packages/utils/src/stream-utils.ts:266