@flowscripter/dynamic-cli-framework-api
    Preparing search index...

    Interface ProgressBarOptions

    Options for PrinterService.showProgressBar.

    interface ProgressBarOptions {
        current?: number;
        format?: (value: number) => string;
        formatRate?: (rate: number) => string;
        message?: string;
        style?: ProgressStyle;
        total?: number;
    }
    Index
    current? format? formatRate? message? style? total?
    current?: number

    The current value which is a portion of the total value, defaults to 0.

    format?: (value: number) => string

    Formats a current or total value for display, e.g. scaling a raw byte count to a human-readable unit. Defaults to String(value).

    formatRate?: (rate: number) => string

    Formats the computed rate (value/s, in the same scale passed to current/total) for display. Called independently of format, so a rate can be shown in a different unit than the total - e.g. a byte total shown in GB whose rate has slowed enough to be clearer in KB/s. Defaults to `${format(rate)}/s`.

    message?: string

    An optional message for the progress bar.

    style?: ProgressStyle

    Optional progress bar rendering style, defaults to ProgressStyle.STROKE.

    total?: number

    The total value which equates to 100% complete, defaults to 100.

    Settings
    Member Visibility

    On This Page
    Properties