Interface ICliPercentageProgressBar

Represents a progress bar for the CLI

interface ICliPercentageProgressBar {
    complete: () => void;
    hide: () => void;
    isRunning: boolean;
    setText: (text: string) => void;
    show: (text?: string) => void;
    update: (
        progress: number,
        options?: CliPercentageProgressBarUpdateValueOptions,
    ) => void;
}

Hierarchy (View Summary)

Properties

complete hide isRunning setText show update

Properties

complete

complete: () => void

Complete the progress bar

Type declaration

    • (): void

    • Returns void

      void

hide

hide: () => void

Hide the progress bar

isRunning

isRunning: boolean

Indicates if the progress bar is running

setText

setText: (text: string) => void

Set the text of the spinner

Type declaration

    • (text: string): void

    • Parameters

      • text: string

        The text to set

      Returns void

show

show: (text?: string) => void

Show the progress bar

update

update: (
    progress: number,
    options?: CliPercentageProgressBarUpdateValueOptions,
) => void

Update the progress of the progress bar

Type declaration

Settings

Member Visibility

On This Page

Properties