Class BufferingStream

This component will buffer whatever is pushed to it and emit chunks back every BufferingStreamOptions.emitInterval. It will also ensure that the emitted chunks never exceed BufferingStreamOptions.maxChunkSize.

Hierarchy

BufferingStream

Index

Constructors

constructor

Properties

Accessors

onData

Methods

Constructors

constructor

new BufferingStream(options?: BufferingStreamOptions): BufferingStream

- Defined in packages/terminal/src/node/buffering-stream.ts:45
Parameters
- Optional options: BufferingStreamOptions
Returns BufferingStream

Properties

Protected Optional buffer

buffer?: Buffer

Protected emitInterval

emitInterval: number

Protected maxChunkSize

maxChunkSize: number

Protected onDataEmitter

onDataEmitter: Emitter<Buffer> = ...

Protected Optional timeout

timeout?: Timeout

Accessors

onData

get onData(): Event<Buffer>

- Defined in packages/terminal/src/node/buffering-stream.ts:50
Returns Event<Buffer>

Methods

dispose

dispose(): void

- Defined in packages/terminal/src/node/buffering-stream.ts:63
Returns void

Protected emitBufferedChunk

emitBufferedChunk(): void

- Defined in packages/terminal/src/node/buffering-stream.ts:69
Returns void

push

push(chunk: Buffer): void

- Defined in packages/terminal/src/node/buffering-stream.ts:54
Parameters
- chunk: Buffer
Returns void