Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ProgressBar

ProgressBar

example
const bar = ProgressBar.create({
  title: 'progress',
  total: 100,
  clean: true,
});
bar.event.on('update-post', (bar) => {
})
bar.start();
bar.update(10);
bar.tick(10);
bar.forceCompleted();

Hierarchy

  • ProgressBar

Implements

Index

Constructors

Private constructor

Properties

clean

clean: boolean

completed

completed: boolean = false

Private Optional completedAt

completedAt: Date

current

current: number

events

events: TypedEventEmitter<ProgressBarEvents> = createEvents<ProgressBarEvents>()

output

started

started: boolean = false

Private Optional startedAt

startedAt: Date

title

title: string

toBarString

toBarString: function

Type declaration

    • (): string
    • Returns string

total

total: number

Optional width

width: undefined | number

Optional widthPercentage

widthPercentage: undefined | number

Accessors

elapsed

  • get elapsed(): number

elapsedHuman

  • get elapsedHuman(): string

eta

  • get eta(): number

etaHuman

  • get etaHuman(): string

percentage

  • get percentage(): number

Methods

Private checkCompleted

  • checkCompleted(): boolean

forceCompleted

  • forceCompleted(): void

Private humanTime

  • humanTime(totalSeconds: number): string

render

  • render(): void

start

  • start(): this

tick

  • tick(delta: number): void
  • Increase current progress

    Parameters

    • delta: number

    Returns void

update

  • update(current: number): void
  • Change current progress

    Parameters

    • current: number

    Returns void

Static create

Static start

Generated using TypeDoc