Class StringBufferingStream

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 (View Summary)

BufferingStream<string>
- StringBufferingStream

Index

Constructors

Properties

buffer? concat emitInterval length maxChunkSize onDataEmitter slice timeout?

Accessors

Methods

dispose emitBufferedChunk push

Constructors

constructor

new StringBufferingStream(
options?: BufferingStreamOptions,
): StringBufferingStream
Parameters
- options: BufferingStreamOptions = {}
Returns StringBufferingStream
Overrides BufferingStream.constructor
- Defined in packages/terminal/src/node/buffering-stream.ts:86

Properties

`Protected` `Optional`buffer

buffer?: string

`Protected` `Readonly`concat

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

`Protected`emitInterval

emitInterval: number

`Protected` `Readonly`length

length: (what: string) => number

`Protected`maxChunkSize

maxChunkSize: number

`Protected`onDataEmitter

onDataEmitter: Emitter<string> = ...

`Protected` `Readonly`slice

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

`Protected` `Optional`timeout

timeout?: Timeout

Accessors

onData

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

Methods

dispose

dispose(): void
Returns void
Inherited from BufferingStream.dispose
- Defined in packages/terminal/src/node/buffering-stream.ts:68

`Protected`emitBufferedChunk

emitBufferedChunk(): void
Returns void
Inherited from BufferingStream.emitBufferedChunk
- Defined in packages/terminal/src/node/buffering-stream.ts:74

push

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