Installation
npm install --save @types/multi-progress
Summary
This package contains type definitions for multi-progress (https://github.com/pitaj/multi-progress).
Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/multi-progress.
index.d.ts
/// <reference types="node"/>
import ProgressBar = require("progress");
import { Stream } from "stream";
export as namespace MultiProgress;
export = MultiProgress;
declare class MultiProgress {
/**
* Create a new @see MultiProgress with the given stream, or stderr by default
* @param stream A stream to write the progress bars to
*/
constructor(stream?: Stream);
/**
* Add a new bar
*/
newBar: (format: string, options: ProgressBar.ProgressBarOptions) => ProgressBar;
/**
* Close all bars
*/
terminate: () => void;
/**
* Render the given progress bar
*/
move: (index: number) => void;
/**
* Move the bar indicated by index forward the number of steps indicated by value
*/
tick: (index: number, value: number, options?: any) => void;
/**
* Update the bar indicated by index to the value given
*/
update: (index: number, value: number, options?: any) => void;
}
declare namespace MultiProgress {}
Additional Details
- Last updated: Tue, 07 Nov 2023 09:09:39 GMT
- Dependencies: @types/node, @types/progress
Credits
These definitions were written by David Brett.