@types/cli-progress
Advanced tools
@types/cli-progress - npm Package Compare versions
Comparing version 1.8.1 to 3.4.0
@@ -1,4 +0,5 @@ | ||
| // Type definitions for cli-progress 1.8 | ||
| // Type definitions for cli-progress 3.4 | ||
| // Project: https://github.com/AndiDittrich/Node.CLI-Progress | ||
| // Definitions by: Mohamed Hegazy <https://github.com/mhegazy> | ||
| // Definitions by: Mohamed Hegazy <https://github.com/mhegazy> | ||
| // Álvaro Martínez <https://github.com/alvaromartmart> | ||
| // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped | ||
@@ -64,2 +65,17 @@ // TypeScript Version: 2.2 | ||
| linewrap?: boolean | null; | ||
| /** trigger redraw during update() in case threshold time x2 is exceeded (default: true) - limited to single bar usage */ | ||
| synchronousUpdate?: boolean; | ||
| /** enable scheduled output to notty streams - e.g. redirect to files (default: false) */ | ||
| noTTYOutput?: boolean; | ||
| /** set the output schedule/interval for notty output in ms (default: 2000ms) */ | ||
| notTTYSchedule?: number; | ||
| /** display progress bars with 'total' of zero(0) as empty, not full (default: false) */ | ||
| emptyOnZero?: boolean; | ||
| /** trigger redraw on every frame even if progress remains the same; can be useful if progress bar gets overwritten by other concurrent writes to the terminal (default: false) */ | ||
| forceRedraw?: boolean; | ||
| } | ||
@@ -70,6 +86,27 @@ | ||
| barIncompleteChar: string; | ||
| /** | ||
| * Example: 'progress [{bar}] {percentage}% | ETA: {eta}s | {value}/{total}' | ||
| * | ||
| * {bar} - the progress bar, customizable by the options barsize, barCompleteString and barIncompleteString | ||
| * | ||
| * {percentage} - the current progress in percent (0-100) | ||
| * | ||
| * {total} - the end value | ||
| * | ||
| * {value} - the current value set by last update() call | ||
| * | ||
| * {eta} - expected time of accomplishment in seconds | ||
| * | ||
| * {duration} - elapsed time in seconds | ||
| * | ||
| * {eta_formatted} - expected time of accomplishment formatted into appropriate units | ||
| * | ||
| * {duration_formatted} - elapsed time formatted into appropriate units | ||
| * | ||
| */ | ||
| format: string; | ||
| } | ||
| export class Bar { | ||
| export class SingleBar { | ||
| /** Initialize a new Progress bar. An instance can be used multiple times! it's not required to re-create it! */ | ||
@@ -104,2 +141,12 @@ constructor(opt: Options, preset?: Preset); | ||
| export class MultiBar { | ||
| constructor(opt: Options, preset?: Preset); | ||
| create(total: number, startValue: number, payload: any): SingleBar; | ||
| remove(bar: SingleBar): boolean; | ||
| stop(): void; | ||
| } | ||
| export const Presets: { | ||
@@ -118,1 +165,3 @@ /** Styles as of cli-progress v1.3.0 */ | ||
| }; | ||
| export class Bar extends SingleBar {} |
| { | ||
| "name": "@types/cli-progress", | ||
| "version": "1.8.1", | ||
| "version": "3.4.0", | ||
| "description": "TypeScript definitions for cli-progress", | ||
@@ -8,9 +8,14 @@ "license": "MIT", | ||
| { | ||
| "name": "Mohamed Hegazy", | ||
| "name": " Mohamed Hegazy", | ||
| "url": "https://github.com/mhegazy", | ||
| "githubUsername": "mhegazy" | ||
| }, | ||
| { | ||
| "name": "Álvaro Martínez", | ||
| "url": "https://github.com/alvaromartmart", | ||
| "githubUsername": "alvaromartmart" | ||
| } | ||
| ], | ||
| "main": "", | ||
| "types": "index", | ||
| "types": "index.d.ts", | ||
| "repository": { | ||
@@ -25,4 +30,4 @@ "type": "git", | ||
| }, | ||
| "typesPublisherContentHash": "be73722bdfd17d14122a23c68c1d9703bf960d966321cc3667406b33e6406e75", | ||
| "typeScriptVersion": "2.2" | ||
| "typesPublisherContentHash": "2b4a0c9aa26653f2c584489615214aa465aba81c05f94f0bb92776095c3c4f06", | ||
| "typeScriptVersion": "2.8" | ||
| } |
@@ -5,13 +5,13 @@ # Installation | ||
| # Summary | ||
| This package contains type definitions for cli-progress ( https://github.com/AndiDittrich/Node.CLI-Progress ). | ||
| This package contains type definitions for cli-progress (https://github.com/AndiDittrich/Node.CLI-Progress). | ||
| # Details | ||
| Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/cli-progress | ||
| Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/cli-progress. | ||
| Additional Details | ||
| * Last updated: Mon, 11 Mar 2019 16:26:55 GMT | ||
| * Dependencies: @types/node | ||
| ### Additional Details | ||
| * Last updated: Thu, 26 Dec 2019 18:27:31 GMT | ||
| * Dependencies: [@types/node](https://npmjs.com/package/@types/node) | ||
| * Global values: none | ||
| # Credits | ||
| These definitions were written by Mohamed Hegazy <https://github.com/mhegazy>. | ||
| These definitions were written by Mohamed Hegazy (https://github.com/mhegazy), and Álvaro Martínez (https://github.com/alvaromartmart). |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by31.07%
8546
- Lines of code
- increased by45.24%
122
No dependency changes