Interface ByteStream<Stream, T>

interface ByteStream<
    Stream = unknown,
    T extends ArrayBufferLike = ArrayBufferLike,
> {
    read(options: ReadOptions): Promise<Uint8ArrayList<T>>;
    read(options?: AbortOptions): Promise<Uint8ArrayList<T> | null>;
    unwrap(): Stream;
    write(
        input: Uint8ArrayList<T> | Uint8Array<T>,
        options?: AbortOptions,
    ): Promise<void>;
}

Type Parameters

Stream = unknown
T extends ArrayBufferLike = ArrayBufferLike

Index

Methods

read unwrap write

Methods

read

read(options: ReadOptions): Promise<Uint8ArrayList<T>>
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: ReadOptions
Returns Promise<Uint8ArrayList<T>>
- Defined in packages/it-byte-stream/src/index.ts:46
read(options?: AbortOptions): Promise<Uint8ArrayList<T> | null>
Parameters
- Optionaloptions: AbortOptions
Returns Promise<Uint8ArrayList<T> | null>
- Defined in packages/it-byte-stream/src/index.ts:47

unwrap

unwrap(): Stream
Returns the underlying stream

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

write

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