Interface ProtobufStream<Stream>

Convenience methods for working with protobuf streams

Type Parameters

Stream = unknown

Hierarchy

ProtobufStream

Index

Properties

pb read readLP readPB unwrap write writeLP writePB

Properties

pb

pb: (<T>(proto: {
decode: Decoder<T>;
encode: Encoder<T>;
}) => MessageStream<T, Stream>)

Type declaration

- <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>;
    }
    - decode: Decoder<T>
    - encode: Encoder<T>
  Returns MessageStream<T, Stream>

read

read: ((bytes?: number) => Promise<Uint8ArrayList>)

Type declaration

- (bytes?: number): Promise<Uint8ArrayList>
- Read a set number of bytes from the stream
  Parameters
  - Optional bytes: number
  Returns Promise<Uint8ArrayList>

readLP

readLP: (() => Promise<Uint8ArrayList>)

Type declaration

- (): Promise<Uint8ArrayList>
- Read the next length-prefixed number of bytes from the stream
  
  Returns Promise<Uint8ArrayList>

readPB

readPB: (<T>(proto: {
decode: Decoder<T>;
}) => Promise<T>)

Type declaration

- <T>(proto: {
  decode: Decoder<T>;
  }): 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>;
    }
    - decode: Decoder<T>
  Returns Promise<T>

unwrap

unwrap: (() => Stream)

Type declaration

- (): Stream
- Returns the underlying stream
  
  Returns Stream

write

write: ((input: Uint8Array | Uint8ArrayList) => void)

Type declaration

- (input: Uint8Array | Uint8ArrayList): void
- Write the passed bytes to the stream
  Parameters
  - input: Uint8Array | Uint8ArrayList
  Returns void

writeLP

writeLP: ((input: Uint8Array | Uint8ArrayList) => void)

Type declaration

- (input: Uint8Array | Uint8ArrayList): void
- Write the passed bytes to the stream prefixed by their length
  Parameters
  - input: Uint8Array | Uint8ArrayList
  Returns void

writePB

writePB: (<T>(data: T, proto: {
encode: Encoder<T>;
}) => void)

Type declaration

- <T>(data: T, proto: {
  encode: Encoder<T>;
  }): void
- Encode the passed object as a protobuf message and write it's length-prefixed bytes tot he stream
  Type Parameters
  - T
  Parameters
  - data: T
  - proto: {
    encode: Encoder<T>;
    }
    - encode: Encoder<T>
  Returns void