Interface ProtobufStream<Stream>

Convenience methods for working with protobuf streams

interface ProtobufStream<Stream = unknown> {
    pb<T>(
        proto: { decode: Decoder<T>; encode: Encoder<T> },
    ): MessageStream<T, Stream>;
    read<T>(proto: { decode: Decoder<T> }, options?: AbortOptions): Promise<T>;
    unwrap(): Stream;
    write<T>(
        data: T,
        proto: { encode: Encoder<T> },
        options?: AbortOptions,
    ): Promise<void>;
    writeV<T>(
        input: T[],
        proto: { encode: Encoder<T> },
        options?: AbortOptions,
    ): Promise<void>;
}

Type Parameters

Stream = unknown

Index

Methods

pb read unwrap write writeV

Methods

pb

pb<T>(
proto: { decode: Decoder<T>; encode: Encoder<T> },
): MessageStream<T, Stream>
Returns an object with read/write methods for operating on one specific type of protobuf message
Type Parameters
- T
Parameters
- proto: { decode: Decoder<T>; encode: Encoder<T> }
Returns MessageStream<T, Stream>
- Defined in it-protobuf-stream/src/index.ts:70

read

read<T>(proto: { decode: Decoder<T> }, options?: AbortOptions): Promise<T>
Read the next length-prefixed byte array from the stream and decode it as the passed protobuf format
Type Parameters
- T
Parameters
- proto: { decode: Decoder<T> }
- Optionaloptions: AbortOptions
Returns Promise<T>
- Defined in it-protobuf-stream/src/index.ts:55

unwrap

unwrap(): Stream
Returns the underlying stream

Returns Stream
- Defined in it-protobuf-stream/src/index.ts:75

write

write<T>(
    data: T,
    proto: { encode: Encoder<T> },
    options?: AbortOptions,
): Promise<void>
Encode the passed object as a protobuf message and write it's length-prefixed bytes to the stream
Type Parameters
- T
Parameters
- data: T
- proto: { encode: Encoder<T> }
- Optionaloptions: AbortOptions
Returns Promise<void>
- Defined in it-protobuf-stream/src/index.ts:60

writeV

writeV<T>(
    input: T[],
    proto: { encode: Encoder<T> },
    options?: AbortOptions,
): Promise<void>
Encode the passed objects as protobuf messages and write their length-prefixed bytes to the stream as a single write
Type Parameters
- T
Parameters
- input: T[]
- proto: { encode: Encoder<T> }
- Optionaloptions: AbortOptions
Returns Promise<void>
- Defined in it-protobuf-stream/src/index.ts:65