exported formatters and utility functions

CHANGES.md

@@ -2,8 +2,9 @@
 
 ### 3.9.0 ###
 
+* Added: exported standard formatter and format helper
 * Added: example howto use multibars in synchronous context
-* Changed: upper eta display limit to `1e7` (115days)
+* Changed: upper eta display limit to `1e7` (115days) #92
 
 ### 3.8.2 ###
 

README.md

@@ -321,6 +321,16 @@ is rendered as
 # Task 1     200/200 --[████████████████████████████████████████]--
 ```
 
+
+### Example 2 ###
+
+You can also access the default format functions to use them within your formatter:
+
+```js
+const {TimeFormat, ValueFormat, BarFormat, Formatter} = require('cli-progess').Format;
+...
+```
+
 Examples
 ---------------------------------------------
 

cli-progress.js

@@ -1,11 +1,21 @@
 const _SingleBar = require('./lib/single-bar');
 const _MultiBar = require('./lib/multi-bar');
 const _Presets = require('./presets/index');
+const _Formatter = require('./lib/formatter');
+const _defaultFormatValue = require('./lib/format-value');
+const _defaultFormatBar = require('./lib/format-bar');
+const _defaultFormatTime = require('./lib/format-time');
 
 // sub-module access
 module.exports = {
     Bar: _SingleBar,
     SingleBar: _SingleBar,
     MultiBar: _MultiBar,
-    Presets: _Presets
+    Presets: _Presets,
+    Format: {
+        Formatter: _Formatter,
+        BarFormat: _defaultFormatBar,
+        ValueFormat: _defaultFormatValue,
+        TimeFormat: _defaultFormatTime
+    }
 };

package.json

@@ -1,6 +1,6 @@
 {
     "name": "cli-progress",
-    "version": "3.8.2",
+    "version": "3.9.0",
     "description": "easy to use progress-bar for command-line/terminal applications",
     "keywords": [
         "cli",
@@ -32,7 +32,7 @@
         "node": ">=4"
     },
     "main": "./cli-progress.js",
-    "author": "Andi Dittrich (https://andidittrich.de)",
+    "author": "Andi Dittrich (https://andidittrich.com)",
     "license": "MIT",
     "dependencies": {
         "colors": "^1.1.2",