Class ProgressBarOutputStream

Progress bar output to NodeJs.WriteStream

Hierarchy

ProgressBarOutput
- ProgressBarOutputStream

Index

Constructors

constructor

Properties

Methods

Constructors

Protected constructor

new ProgressBarOutputStream(options?: Partial<ProgressBarOutputStreamOptions>): ProgressBarOutputStream

Overrides ProgressBarOutput.constructor
- Defined in output.ts:115
Parameters
- Default value options: Partial<ProgressBarOutputStreamOptions> = {}
Returns ProgressBarOutputStream

Properties

bars

bars: ProgressBar[] = []

events

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

Protected Optional lastOutputAt

lastOutputAt: Date

Optional multiProgressBar

multiProgressBar: MultiProgressBar

Protected outputHeight

outputHeight: number = 0

Protected outputTimer

outputTimer: Timeout | null = null

Optional outputWidth

outputWidth: undefined | number

Protected refreshDiffMilliseconds

refreshDiffMilliseconds: number

refreshRate

refreshRate: number

stream

stream: WriteStream

Methods

addBar

addBar(bar: ProgressBar): void

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

clearScreenDown

clearScreenDown(): void

- Defined in output.ts:134
Returns void

forceOutput

forceOutput(): void

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

Private getOutputColumns

getOutputColumns(): number

- Defined in output.ts:130
Returns number

output

output(): void

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

realOutput

realOutput(): void

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

removeBar

removeBar(bar: ProgressBar): void

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

Static create

create(options?: Partial<ProgressBarOutputStreamOptions>): ProgressBarOutputStream

- Defined in output.ts:113
Parameters
- Default value options: Partial<ProgressBarOutputStreamOptions> = {}
Returns ProgressBarOutputStream

Generated using TypeDoc