Interface MessageStream<T, S>

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

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

Type Parameters

T
S = unknown

Index

Methods

read unwrap write writeV

Methods

read

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

unwrap

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

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

write

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

writeV

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