Class FramedReader<Frame>

a reader that decodes frames one by one from a readable stream

Type Parameters

Frame

Index

Constructors

Methods

[asyncIterator] read

Constructors

constructor

new FramedReader<Frame>(
    readable: IReadable,
    decoder: IFrameDecoder<Frame>,
    options?: FramedReaderOptions,
): FramedReader<Frame>
Type Parameters
- Frame
Parameters
- readable: IReadable
  fuman readable stream to read from
- decoder: IFrameDecoder<Frame>
  frame decoder
- Optionaloptions: FramedReaderOptions
  extra options
Returns FramedReader<Frame>
- Defined in packages/io/src/codec/reader.ts:28

Methods

[asyncIterator]

"[asyncIterator]"(): AsyncIterator<Frame, any, any>
create an async iterator that yields frames

Returns AsyncIterator<Frame, any, any>
- Defined in packages/io/src/codec/reader.ts:69

read

read(): Promise<null | Frame>
read a next frame from the stream, or null if the stream ended

Returns Promise<null | Frame>
- Defined in packages/io/src/codec/reader.ts:40