@feng-j/console-progress/lib/types/singleLine.d.ts

在 node 终端控制台中输出进度条

import { BaseLine, PayloadType, ProgressOption } from './baseLine';
export interface LineOption extends ProgressOption {
    hideCursor?: boolean;
    log?: boolean;
}
export declare class SingleLine extends BaseLine {
    private readonly lineOption;
    constructor(option?: LineOption);
    private write;
    /**
     * 输出进度条
     * @protected
     */
    protected log(): void;
    /**
     * 初始化进度条任务数量
     * @param total 全部的任务数量
     * @param current 开始时的任务数量，默认为 0
     * @param data 渲染进度条时需要渲染的数据
     */
    start(total: number, current?: number, data?: PayloadType): void;
    /**
     * 更新完成的任务数量
     * @param current 已完成任务数量
     * @param data 渲染进度条时需要渲染的数据
     */
    update(current: number, data?: PayloadType): void;
    /**
     * 步进任务数量
     * @param step 步进数量
     * @param data 渲染进度条需要的额外数量
     */
    increment(step?: number, data?: PayloadType): void;
    /**
     * 停止进度条
     */
    stop(): void;
}