Class FramedWriter<Frame>

a writer that encodes frames one by one into a writable stream

Type Parameters

Frame = Uint8Array

Index

Constructors

Methods

Constructors

constructor

new FramedWriter<Frame = Uint8Array>(
    writable: IWritable,
    encoder: IFrameEncoder<Frame>,
    options?: FramedWriterOptions,
): FramedWriter<Frame>
Type Parameters
- Frame = Uint8Array
Parameters
- writable: IWritable
  fuman writable stream to write to
- encoder: IFrameEncoder<Frame>
  frame encoder
- Optionaloptions: FramedWriterOptions
  extra options
Returns FramedWriter<Frame>
- Defined in packages/io/src/codec/writer.ts:24

Methods

write

write(frame: Frame): Promise<void>
write a frame to the stream
Parameters
- frame: Frame
Returns Promise<void>
- Defined in packages/io/src/codec/writer.ts:37