Class BufferingStream<T>

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.

Type Parameters

T

Hierarchy (View Summary)

BufferingStream
- StringBufferingStream
- BufferBufferingStream

Index

Constructors

Properties

buffer? concat emitInterval length maxChunkSize onDataEmitter slice timeout?

Accessors

Methods

dispose emitBufferedChunk flush push

Constructors

constructor

new BufferingStream<T>(
    options?: BufferingStreamOptions,
    concat: (left: T, right: T) => T,
    slice: (what: T, start?: number, end?: number) => T,
    length: (what: T) => number,
): BufferingStream<T>
Type Parameters
- T
Parameters
- options: BufferingStreamOptions = {}
- concat: (left: T, right: T) => T
- slice: (what: T, start?: number, end?: number) => T
- length: (what: T) => number
Returns BufferingStream<T>
- Defined in packages/terminal/src/node/buffering-stream.ts:47

Properties

`Protected` `Optional`buffer

buffer?: T

`Protected` `Readonly`concat

concat: (left: T, right: T) => T

`Protected`emitInterval

emitInterval: number

`Protected` `Readonly`length

length: (what: T) => number

`Protected`maxChunkSize

maxChunkSize: number

`Protected`onDataEmitter

onDataEmitter: Emitter<T> = ...

`Protected` `Readonly`slice

slice: (what: T, start?: number, end?: number) => T

`Protected` `Optional`timeout

timeout?: Timeout

Accessors

onData

get onData(): Event<T>
Returns Event<T>
- Defined in packages/terminal/src/node/buffering-stream.ts:55

Methods

dispose

dispose(): void
Returns void
- Defined in packages/terminal/src/node/buffering-stream.ts:81

`Protected`emitBufferedChunk

emitBufferedChunk(): void
Returns void
- Defined in packages/terminal/src/node/buffering-stream.ts:87

flush

flush(): void
Immediately drains all buffered data, cancelling any pending timed flush.

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

push

push(chunk: T): void
Parameters
- chunk: T
Returns void
- Defined in packages/terminal/src/node/buffering-stream.ts:59