multi-progress-bars
Advanced tools
Comparing version 1.1.1 to 1.1.2
@@ -5,2 +5,9 @@ # Changelog | ||
### [1.1.2](https://github.com/kamiyo/multi-progress-bars/compare/v1.1.1...v1.1.2) (2020-07-26) | ||
### Bug Fixes | ||
* **readme:** Added some <> on the types under API entries. ([dae0174](https://github.com/kamiyo/multi-progress-bars/commit/dae0174123b9e0974a70713c0c73f64e8ff78da6)) | ||
### [1.1.1](https://github.com/kamiyo/multi-progress-bars/compare/v1.1.0...v1.1.1) (2020-07-26) | ||
@@ -7,0 +14,0 @@ |
{ | ||
"name": "multi-progress-bars", | ||
"version": "1.1.1", | ||
"version": "1.1.2", | ||
"description": "Multiple progress bars with option for indefinite spinners", | ||
@@ -5,0 +5,0 @@ "main": "dist/multi-progress-bars.cjs.js", |
@@ -68,3 +68,3 @@ # multi-progress-bars | ||
`options` `object` (all optional): | ||
`options` `<object>` (all optional): | ||
* `stream` `<TTY.WriteStream>` Can be `process.stdout` or `process.stderr`. default = `process.stdout` | ||
@@ -79,5 +79,5 @@ * `spinnerFPS` `<number>` The FPS to update the spinner. default = `10` | ||
`name` `string` Task name. All subsequent actions on the task will be called with this same name. | ||
`name` `<string>` Task name. All subsequent actions on the task will be called with this same name. | ||
`options` `object`: | ||
`options` `<object>`: | ||
* `type` `<'percentage' | 'indefinite'>` required. | ||
@@ -93,5 +93,5 @@ * `index` `<number>` required. default = increment from previous || 0. | ||
`name` `string` Task name. | ||
`name` `<string>` Task name. | ||
`options` `object` (unset properties will not affect change unless a default exists): | ||
`options` `<object>` (unset properties will not affect change unless a default exists): | ||
* `message` `<string>` optional. A message to print to the right of the bar. | ||
@@ -105,5 +105,5 @@ * `percentage` `<number>` optional. The amount to increment by. default = `0.01` | ||
`name` `string` Task name. | ||
`name` `<string>` Task name. | ||
`options` `object` (unset properties will not affect change): | ||
`options` `<object>` (unset properties will not affect change): | ||
* `message` `<string>` optional. A message to print to the right of the bar. | ||
@@ -117,5 +117,5 @@ * `percentage` `<number>` optional. The amount to change the percentage to. | ||
`name` `string` Task name. | ||
`name` `<string>` Task name. | ||
`options` `object` (unset properties will not affect change): | ||
`options` `<object>` (unset properties will not affect change): | ||
* `message` `<string>` optional. A message to print to the right of the bar. default = `chalk.green('Finished')` | ||
@@ -126,5 +126,5 @@ * `barColorFn` `<(s: string) => string>` optional. A function that transforms the bar. | ||
`name` `string` Task name. | ||
`name` `<string>` Task name. | ||
`options` `object` (unset properties will not affect change): | ||
`options` `<object>` (unset properties will not affect change): | ||
* `message` `<string>` optional. A message to print to the right of the bar. | ||
@@ -131,0 +131,0 @@ * `barColorFn` `<(s: string) => string>` optional. A function that transforms the bar. |
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
40616