multi-progress-bars
Advanced tools
Comparing version 1.1.2 to 1.1.3
@@ -5,2 +5,9 @@ # Changelog | ||
### [1.1.3](https://github.com/kamiyo/multi-progress-bars/compare/v1.1.2...v1.1.3) (2020-07-26) | ||
### Bug Fixes | ||
* **readme:** Added language for markdown highlighting ([a35041a](https://github.com/kamiyo/multi-progress-bars/commit/a35041a909d3c07d6dadc2db21876d34d5c794a1)) | ||
### [1.1.2](https://github.com/kamiyo/multi-progress-bars/compare/v1.1.1...v1.1.2) (2020-07-26) | ||
@@ -7,0 +14,0 @@ |
{ | ||
"name": "multi-progress-bars", | ||
"version": "1.1.2", | ||
"version": "1.1.3", | ||
"description": "Multiple progress bars with option for indefinite spinners", | ||
@@ -5,0 +5,0 @@ "main": "dist/multi-progress-bars.cjs.js", |
@@ -15,3 +15,3 @@ # multi-progress-bars | ||
Each bar is represented internally by a `Task`. First instantiate `MultiProgressBars`: | ||
``` | ||
```node | ||
import { MultiProgressBars } from 'multi-progress-bars'; | ||
@@ -23,3 +23,3 @@ | ||
Then you can add bars by adding tasks: | ||
``` | ||
```node | ||
const Task1 = 'Task 1' | ||
@@ -30,3 +30,3 @@ mpb.addTask(Task1, { type: 'percentage', index: 0 }); | ||
Spice up the bars by passing in a string transform function: | ||
``` | ||
```node | ||
import * as chalk from 'chalk'; // or colors.js | ||
@@ -39,3 +39,3 @@ | ||
Create an indefinite spinner by: | ||
``` | ||
```node | ||
const Task2 = 'Task 2' | ||
@@ -46,3 +46,3 @@ mpb.addTask(Task2, { type: 'indefinite', index: 2 }); | ||
Update the bars with either incrementTask or updateTask: | ||
``` | ||
```node | ||
mpb.updateTask(Task1, { percentage: 0.3 }); | ||
@@ -54,3 +54,3 @@ // or | ||
When task is done call done(). A percentage of 1(00%) does not imply done: | ||
``` | ||
```node | ||
mpb.done(Task1); | ||
@@ -60,3 +60,3 @@ ``` | ||
multi-progress-bars exposes a Promise that will be resolved when all tasks are done: | ||
``` | ||
```node | ||
await mpb.promise; | ||
@@ -146,3 +146,3 @@ // Do stuff here when all tasks finish | ||
``` | ||
```node | ||
const glob = require('glob'); | ||
@@ -202,3 +202,3 @@ const { Transform } = require('stream'); | ||
``` | ||
```node | ||
// webpack.dev.config.js | ||
@@ -205,0 +205,0 @@ |
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
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
40928