Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ProgressBarInstance

Progress bar instance.

Hierarchy

  • ProgressBarInstance

Index

Properties

Methods

Properties

action

action: string

Action string

length

length: number

Progress bar length

term

term: XTermInterface

Underlying terminal.

Readonly text

text: string

Progress bar text.

Methods

setProgress

  • setProgress(n: number): void

  • Sets progress.

    Parameters

    • n: number

      The progress to use.

    Returns void

stop

  • stop(msg: string, noLB?: boolean): void

  • Stops progress.

    Parameters

    • msg: string

      Stop message.

    • Optional noLB: boolean

      Add line break? Default is false.

    Returns void

Generated using TypeDoc