Class ProgressBarOutputBuffer

Progress bar output to string

Hierarchy

ProgressBarOutput
- ProgressBarOutputBuffer

Index

Constructors

constructor

Properties

Methods

Constructors

Protected constructor

new ProgressBarOutputBuffer(bufferWidth: number, options?: Partial<ProgressBarOutputOptions>): ProgressBarOutputBuffer

Overrides ProgressBarOutput.constructor
- Defined in output.ts:198
Parameters
- bufferWidth: number
- Default value options: Partial<ProgressBarOutputOptions> = {}
Returns ProgressBarOutputBuffer

Properties

bars

bars: ProgressBar[] = []

buffer

buffer: string = ""

events

events: TypedEventEmitter<object> = createEvents<ProgressBarOutputEvents>()

Protected Optional lastOutputAt

lastOutputAt: Date

Optional multiProgressBar

multiProgressBar: MultiProgressBar

Protected outputTimer

outputTimer: Timeout | null = null

Optional outputWidth

outputWidth: undefined | number

Protected refreshDiffMilliseconds

refreshDiffMilliseconds: number

refreshRate

refreshRate: number

Methods

addBar

addBar(bar: ProgressBar): void

Inherited from ProgressBarOutput.addBar
- Defined in output.ts:52
Parameters
- bar: ProgressBar
Returns void

forceOutput

forceOutput(): void

Inherited from ProgressBarOutput.forceOutput
- Defined in output.ts:66
Returns void

output

output(): void

Inherited from ProgressBarOutput.output
- Defined in output.ts:80
Returns void

realOutput

realOutput(): void

Overrides ProgressBarOutput.realOutput
- Defined in output.ts:209
Returns void

removeBar

removeBar(bar: ProgressBar): void

Inherited from ProgressBarOutput.removeBar
- Defined in output.ts:58
Parameters
- bar: ProgressBar
Returns void

Static create

create(bufferWidth: number, options?: Partial<ProgressBarOutputOptions>): ProgressBarOutputBuffer

- Defined in output.ts:193
Parameters
- bufferWidth: number
- Default value options: Partial<ProgressBarOutputOptions> = {}
Returns ProgressBarOutputBuffer

Generated using TypeDoc