@types/cli-progress - npm Package Compare versions

Comparing version 3.8.0 to 3.9.0

cli-progress/index.d.ts

@@ -1,2 +0,2 @@
-// Type definitions for cli-progress 3.8
+// Type definitions for cli-progress 3.9
 // Project: https://github.com/AndiDittrich/Node.CLI-Progress
@@ -36,12 +36,12 @@ // Definitions by:  Mohamed Hegazy <https://github.com/mhegazy>
      */
-    format?: string | ((options: Options, params: Params, payload: any) => string);
+    format?: string | GenericFormatter;
 
     /** a custom bar formatter function which renders the bar-element (default: format-bar.js) */
-    formatBar?: (progress: number, options: Options) => string;
+    formatBar?: BarFormatter;
 
     /** 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;
+    formatTime?: TimeFormatter;
 
     /** a custom value formatter function which renders all other values (default: format-value.js) */
-    formatValue?: (v: number, options: Options, type: string) => string;
+    formatValue?: ValueFormatter;
 
@@ -134,3 +134,3 @@ /** the maximum update rate (default: 10) */
      *
-     * {eta} - expected time of accomplishment in seconds
+     * {eta} -  expected time of accomplishment in seconds (limited to 115days, otherwise INF is displayed)
      *
@@ -205,2 +205,34 @@ * {duration} - elapsed time in seconds
 
+export interface GenericFormatter {
+    (options: Options, params: Params, payload: any): string;
+}
+
+export interface TimeFormatter {
+    (t: number, options: Options, roundToMultipleOf: number): string;
+}
+
+export interface ValueFormatter {
+    (v: number, options: Options, type: ValueType): string;
+}
+
+export interface BarFormatter {
+    (progress: number, options: Options): string;
+}
+
+export type ValueType = 'percentage' | 'total' | 'value' | 'eta' | 'duration';
+
+declare const defaultFormatter: GenericFormatter;
+declare const formatBar: BarFormatter;
+declare const formatValue: ValueFormatter;
+declare const formatTime: TimeFormatter;
+
+export const Format: {
+    Formatter: typeof defaultFormatter;
+    BarFormat: typeof formatBar;
+    ValueFormat: typeof formatValue;
+    TimeFormat: typeof formatTime;
+};
+
 export class Bar extends SingleBar {}
+
+export {};

cli-progress/package.json

 {
     "name": "@types/cli-progress",
-    "version": "3.8.0",
+    "version": "3.9.0",
     "description": "TypeScript definitions for cli-progress",
@@ -34,4 +34,4 @@ "license": "MIT",
     },
-    "typesPublisherContentHash": "4002f67dc1be3ab54e86ef5515496748c297e2c26f7d9b1d1bab1acbd47f0a53",
-    "typeScriptVersion": "3.0"
+    "typesPublisherContentHash": "cff4b9f36a47e60901fa2dc2af83b78f9244aac7263d0558d0247fdf4f850c54",
+    "typeScriptVersion": "3.4"
 }

cli-progress/README.md

@@ -11,3 +11,3 @@ # Installation
 ### Additional Details
- * Last updated: Fri, 14 Aug 2020 22:06:44 GMT
+ * Last updated: Fri, 19 Feb 2021 21:18:24 GMT
  * Dependencies: [@types/node](https://npmjs.com/package/@types/node)
@@ -14,0 +14,0 @@ * Global values: none

No alert changes

Improved metrics

Total package byte prevSize

11201

increased by6.74%

Lines of code

179

increased by15.48%

No dependency changes