alacritty-theme-switch/esm/deps/jsr.io/@std/cli/1.0.25/unstable_progress_bar.d.ts

CLI utility for switching Alacritty color themes

/**
 * The properties provided to the fmt function upon every visual update.
 */
export interface ProgressBarFormatter {
    /**
     * A formatted version of the duration.
     * `mm:ss`
     */
    styledTime: string;
    /**
     * A function that returns a formatted version of the data received.
     * `0.40/97.66 KiB`
     * @param fractions The number of decimal places the values should have.
     */
    styledData: (fractions?: number) => string;
    /**
     * The progress bar string.
     * Default Style: `###-------`
     */
    progressBar: string;
    /**
     * The duration of the progress bar.
     */
    time: number;
    /**
     * The duration passed to the last call.
     */
    previousTime: number;
    /**
     * The current value the progress bar is sitting at.
     */
    value: number;
    /**
     * The value passed to the last call.
     */
    previousValue: number;
    /**
     * The max value expected to receive.
     */
    max: number;
}
/**
 * The options that are provided to a {@link createProgressBar} or
 * {@link ProgressBarStream}.
 */
export interface ProgressBarOptions {
    /**
     * The {@link WritableStream} that will receive the progress bar reports.
     * @default {Deno.stderr.writable}
     */
    writable?: WritableStream<Uint8Array>;
    /**
     * The offset size of the input if progress is resuming part way through.
     * @default {0}
     */
    value?: number;
    /**
     * The total size expected to receive.
     */
    max: number;
    /**
     * The length that the progress bar should be, in characters.
     * @default {50}
     */
    barLength?: number;
    /**
     * The character to fill the progress bar up with as it makes progress.
     * @default {'#'}
     */
    fillChar?: string;
    /**
     * The character the progress bar starts out with.
     * @default {'-'}
     */
    emptyChar?: string;
    /**
     * Whether the progress bar should be removed after completion.
     * @default {false}
     */
    clear?: boolean;
    /**
     * A function that creates the style of the progress bar.
     * Default Style: `[mm:ss] [###-------] [0.24/97.6 KiB]`.
     */
    formatter?: (formatter: ProgressBarFormatter) => string;
    /**
     * Whether the writable should be kept open when progress bar stops.
     * @default {true}
     */
    keepOpen?: boolean;
    /**
     * How often the progress bar updates. The progress bar will be updated every
     * `refreshMilliseconds` milliseconds.
     * @default {1000}
     */
    refreshMilliseconds?: number;
}
/**
 * `ProgressBar` is a customisable class that reports updates to a
 * {@link WritableStream} on a 1s interval. Progress is communicated by using
 * the `ProgressBar.value` property.
 *
 * @experimental **UNSTABLE**: New API, yet to be vetted.
 *
 * @example Basic Usage
 * ```ts ignore
 * import { delay } from "@std/async";
 * import { ProgressBar } from "@std/cli/unstable-progress-bar";
 *
 * const gen = async function* () {
 *   for (let i = 0; i < 100; ++i) {
 *     yield new Uint8Array(1000).fill(97);
 *     await delay(Math.random() * 200 | 0);
 *   }
 * }();
 * const writer = (await Deno.create("./_tmp/output.txt")).writable.getWriter();
 *
 * const bar = new ProgressBar({ max: 100_000 });
 *
 * for await (const buffer of gen) {
 *   bar.value += buffer.length;
 *   await writer.write(buffer);
 * }
 *
 * await bar.stop();
 * await writer.close();
 * ```
 *
 * @example Custom Formatting
 * ```ts ignore
 * import { delay } from "@std/async";
 * import { ProgressBar } from "@std/cli/unstable-progress-bar";
 *
 * const bar = new ProgressBar({
 *   max: 100,
 *   formatter(formatter) {
 *     return `[${formatter.styledTime}] [${formatter.progressBar}] [${formatter.value}/${formatter.max} files]`;
 *   },
 * });
 *
 * for (const x of Array(100)) {
 *   bar.value += 1;
 *   await delay(Math.random() * 500);
 * }
 *
 * await bar.stop();
 */
export declare class ProgressBar {
    #private;
    /**
     * The current progress that has been completed.
     * @example Usage
     * ```ts no-assert
     * import { ProgressBar } from "@std/cli/unstable-progress-bar";
     *
     * const progressBar = new ProgressBar({ max : 10 });
     * progressBar.value += 1;
     *
     * // do stuff
     *
     * await progressBar.stop();
     * ```
     */
    value: number;
    /**
     * The maximum progress that is expected.
     * @example Usage
     * ```ts no-assert
     * import { ProgressBar } from "@std/cli/unstable-progress-bar";
     *
     * const progressBar = new ProgressBar({ max : 1 });
     * progressBar.max = 100;
     *
     * // do stuff
     *
     * await progressBar.stop();
     * ```
     */
    max: number;
    /**
     * Constructs a new instance.
     *
     * @param options The options to configure various settings of the progress bar.
     */
    constructor(options: ProgressBarOptions);
    /**
     * Ends the progress bar and cleans up any lose ends.
     *
     * @example Usage
     * ```ts ignore
     * import { ProgressBar } from "@std/cli/unstable-progress-bar";
     *
     * const progressBar = new ProgressBar({ max: 100 });
     * await progressBar.stop()
     * ```
     */
    stop(): Promise<void>;
}
//# sourceMappingURL=unstable_progress_bar.d.ts.map