Interface LengthPrefixedStream<Stream>

interface LengthPrefixedStream<Stream> {
    read(options?): Promise<Uint8ArrayList>;
    unwrap(): Stream;
    write(input, options?): Promise<void>;
    writeV(input, options?): Promise<void>;
}

Type Parameters

Stream = unknown

Index

Methods

read unwrap write writeV

Methods

read

read(options?): Promise<Uint8ArrayList>
Read the next length-prefixed number of bytes from the stream
Parameters
- Optional options: AbortOptions
Returns Promise<Uint8ArrayList>
- Defined in it-length-prefixed-stream/src/index.ts:37

unwrap

unwrap(): Stream
Returns the underlying stream

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

write

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

writeV

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