Interface ByteStream<Stream>

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

Type Parameters

Stream = unknown

Index

Methods

read unwrap write

Methods

read

read(bytes?, options?): Promise<Uint8ArrayList>
Read a set number of bytes from the stream
Parameters
- Optional bytes: number
- Optional options: AbortOptions
Returns Promise<Uint8ArrayList>
- Defined in packages/it-byte-stream/src/index.ts:62

unwrap

unwrap(): Stream
Returns the underlying stream

Returns Stream
- Defined in packages/it-byte-stream/src/index.ts:72

write

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