Interface LengthPrefixedStream<Stream>

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

Type Parameters

Stream = unknown

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 it-length-prefixed-stream/src/index.ts:38

unwrap

unwrap(): Stream
Returns the underlying stream

Returns Stream
- Defined in it-length-prefixed-stream/src/index.ts:53

write

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

writeV

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