@types/cli-progress - npm Package Compare versions

Comparing version 3.4.2 to 3.7.0

cli-progress/index.d.ts

@@ -1,2 +0,2 @@
-// Type definitions for cli-progress 3.4
+// Type definitions for cli-progress 3.7
 // Project: https://github.com/AndiDittrich/Node.CLI-Progress
@@ -10,2 +10,11 @@ // Definitions by:  Mohamed Hegazy <https://github.com/mhegazy>
 
+export interface Params {
+    progress: number;
+    eta: number;
+    startTime: Date;
+    total: number;
+    value: number;
+    maxWidth: number;
+}
+
 export interface Options {
@@ -29,4 +38,13 @@ /**
      */
-    format?: string;
+    format?: string | ((options: Options, params: Params, payload: any) => string);
 
+    /** a custom bar formatter function which renders the bar-element (default: format-bar.js) */
+    formatBar?: (progress: number, options: Options) => string;
+
+    /** a custom timer formatter function which renders the formatted time elements like eta_formatted and duration-formatted (default: format-time.js) */
+    formatTime?: (t: number, options: Options, roundToMultipleOf: number) => string;
+
+    /** a custom value formatter function which renders all other values (default: format-value.js) */
+    formatValue?: (v: number, options: Options, type: string) => string;
+
     /** the maximum update rate (default: 10) */
@@ -46,2 +64,3 @@ fps?: number;
     barsize?: number;
+
     /**  position of the progress bar - 'left' (default), 'right' or 'center  */
@@ -88,2 +107,8 @@ align?: 'left' | 'right' | 'center';
     forceRedraw?: boolean;
+
+    /** add padding chars to formatted time and percentage to force fixed width (default: false) */
+    autopadding?: boolean;
+
+    /** the character sequence used for autopadding (default: " ") */
+    autopaddingChar?: string;
 }
@@ -151,3 +176,3 @@
 
-    create(total: number, startValue: number, payload: any): SingleBar;
+    create(total: number, startValue: number, payload?: any): SingleBar;
 
@@ -154,0 +179,0 @@ remove(bar: SingleBar): boolean;

cli-progress/package.json

 {
     "name": "@types/cli-progress",
-    "version": "3.4.2",
+    "version": "3.7.0",
     "description": "TypeScript definitions for cli-progress",
@@ -29,4 +29,4 @@ "license": "MIT",
     },
-    "typesPublisherContentHash": "8ac8a54d92fc07c0103953c80864cf9e8a90ab1835b69712af0216514c69c5ba",
-    "typeScriptVersion": "2.8"
+    "typesPublisherContentHash": "0ca411a6963d4222f9bd5d50d435ab4b4f95666ebee05cc764193d9e8ef17db1",
+    "typeScriptVersion": "2.9"
 }

cli-progress/README.md

@@ -11,3 +11,3 @@ # Installation
 ### Additional Details
- * Last updated: Wed, 29 Jan 2020 21:49:44 GMT
+ * Last updated: Tue, 05 May 2020 00:10:16 GMT
  * Dependencies: [@types/node](https://npmjs.com/package/@types/node)
@@ -17,2 +17,2 @@ * Global values: none
 # Credits
-These definitions were written by  Mohamed Hegazy (https://github.com/mhegazy), and Álvaro Martínez (https://github.com/alvaromartmart).
+These definitions were written by [ Mohamed Hegazy](https://github.com/mhegazy), and [Álvaro Martínez](https://github.com/alvaromartmart).

No alert changes

Improved metrics

Total package byte prevSize

9719

increased by11.27%

Lines of code

145

increased by14.17%

No dependency changes