Interface MessageStream<T, S>

A message reader/writer that only uses one type of message

interface MessageStream<T, S> {
    read(options?): Promise<T>;
    unwrap(): ProtobufStream<S>;
    write(d, options?): Promise<void>;
    writeV(d, options?): Promise<void>;
}

Type Parameters

T
S = unknown

Index

Methods

read unwrap write writeV

Methods

read

read(options?): Promise<T>
Read a message from the stream
Parameters
- Optional options: AbortOptions
Returns Promise<T>
- Defined in it-protobuf-stream/src/index.ts:88

unwrap

unwrap(): ProtobufStream<S>
Unwrap the underlying protobuf stream

Returns ProtobufStream<S>
- Defined in it-protobuf-stream/src/index.ts:103

write

write(d, options?): Promise<void>
Write a message to the stream
Parameters
- d: T
- Optional options: AbortOptions
Returns Promise<void>
- Defined in it-protobuf-stream/src/index.ts:93

writeV

writeV(d, options?): Promise<void>
Write several messages to the stream
Parameters
- d: T[]
- Optional options: AbortOptions
Returns Promise<void>
- Defined in it-protobuf-stream/src/index.ts:98