cli-spinners
Advanced tools
Comparing version 2.0.0 to 2.1.0
194
index.d.ts
@@ -1,99 +0,107 @@ | ||
export type SpinnerName = | ||
| 'dots' | ||
| 'dots2' | ||
| 'dots3' | ||
| 'dots4' | ||
| 'dots5' | ||
| 'dots6' | ||
| 'dots7' | ||
| 'dots8' | ||
| 'dots9' | ||
| 'dots10' | ||
| 'dots11' | ||
| 'dots12' | ||
| 'line' | ||
| 'line2' | ||
| 'pipe' | ||
| 'simpleDots' | ||
| 'simpleDotsScrolling' | ||
| 'star' | ||
| 'star2' | ||
| 'flip' | ||
| 'hamburger' | ||
| 'growVertical' | ||
| 'growHorizontal' | ||
| 'balloon' | ||
| 'balloon2' | ||
| 'noise' | ||
| 'bounce' | ||
| 'boxBounce' | ||
| 'boxBounce2' | ||
| 'triangle' | ||
| 'arc' | ||
| 'circle' | ||
| 'squareCorners' | ||
| 'circleQuarters' | ||
| 'circleHalves' | ||
| 'squish' | ||
| 'toggle' | ||
| 'toggle2' | ||
| 'toggle3' | ||
| 'toggle4' | ||
| 'toggle5' | ||
| 'toggle6' | ||
| 'toggle7' | ||
| 'toggle8' | ||
| 'toggle9' | ||
| 'toggle10' | ||
| 'toggle11' | ||
| 'toggle12' | ||
| 'toggle13' | ||
| 'arrow' | ||
| 'arrow2' | ||
| 'arrow3' | ||
| 'bouncingBar' | ||
| 'bouncingBall' | ||
| 'smiley' | ||
| 'monkey' | ||
| 'hearts' | ||
| 'clock' | ||
| 'earth' | ||
| 'moon' | ||
| 'runner' | ||
| 'pong' | ||
| 'shark' | ||
| 'dqpb' | ||
| 'weather' | ||
| 'christmas' | ||
| 'grenade' | ||
| 'point' | ||
| 'layer'; | ||
declare namespace cliSpinners { | ||
type SpinnerName = | ||
| 'dots' | ||
| 'dots2' | ||
| 'dots3' | ||
| 'dots4' | ||
| 'dots5' | ||
| 'dots6' | ||
| 'dots7' | ||
| 'dots8' | ||
| 'dots9' | ||
| 'dots10' | ||
| 'dots11' | ||
| 'dots12' | ||
| 'line' | ||
| 'line2' | ||
| 'pipe' | ||
| 'simpleDots' | ||
| 'simpleDotsScrolling' | ||
| 'star' | ||
| 'star2' | ||
| 'flip' | ||
| 'hamburger' | ||
| 'growVertical' | ||
| 'growHorizontal' | ||
| 'balloon' | ||
| 'balloon2' | ||
| 'noise' | ||
| 'bounce' | ||
| 'boxBounce' | ||
| 'boxBounce2' | ||
| 'triangle' | ||
| 'arc' | ||
| 'circle' | ||
| 'squareCorners' | ||
| 'circleQuarters' | ||
| 'circleHalves' | ||
| 'squish' | ||
| 'toggle' | ||
| 'toggle2' | ||
| 'toggle3' | ||
| 'toggle4' | ||
| 'toggle5' | ||
| 'toggle6' | ||
| 'toggle7' | ||
| 'toggle8' | ||
| 'toggle9' | ||
| 'toggle10' | ||
| 'toggle11' | ||
| 'toggle12' | ||
| 'toggle13' | ||
| 'arrow' | ||
| 'arrow2' | ||
| 'arrow3' | ||
| 'bouncingBar' | ||
| 'bouncingBall' | ||
| 'smiley' | ||
| 'monkey' | ||
| 'hearts' | ||
| 'clock' | ||
| 'earth' | ||
| 'moon' | ||
| 'runner' | ||
| 'pong' | ||
| 'shark' | ||
| 'dqpb' | ||
| 'weather' | ||
| 'christmas' | ||
| 'grenade' | ||
| 'point' | ||
| 'layer'; | ||
export interface Spinner { | ||
/** | ||
* Recommended interval. | ||
*/ | ||
readonly interval: number; | ||
interface Spinner { | ||
/** | ||
Recommended interval. | ||
*/ | ||
readonly interval: number; | ||
/** | ||
* A list of frames to show for the spinner. | ||
*/ | ||
readonly frames: string[]; | ||
/** | ||
A list of frames to show for the spinner. | ||
*/ | ||
readonly frames: string[]; | ||
} | ||
} | ||
/** | ||
* 60+ spinners for use in the terminal. | ||
* | ||
* @example | ||
* | ||
* const cliSpinners = require('cli-spinners'); | ||
* | ||
* console.log(cliSpinners.dots); | ||
* // { | ||
* // interval: 80, | ||
* // frames: ['⠋', '⠙', '⠹', '⠸', '⠼', '⠴', '⠦', '⠧', '⠇', '⠏'] | ||
* // } | ||
*/ | ||
declare const cliSpinners: {readonly [spinnerName in SpinnerName]: Spinner}; | ||
60+ spinners for use in the terminal. | ||
export default cliSpinners; | ||
@example | ||
``` | ||
import cliSpinners = require('cli-spinners'); | ||
console.log(cliSpinners.dots); | ||
// { | ||
// interval: 80, | ||
// frames: ['⠋', '⠙', '⠹', '⠸', '⠼', '⠴', '⠦', '⠧', '⠇', '⠏'] | ||
// } | ||
``` | ||
*/ | ||
declare const cliSpinners: { | ||
readonly [spinnerName in cliSpinners.SpinnerName]: cliSpinners.Spinner; | ||
} & { | ||
// TODO: Remove this for the next major release | ||
default: typeof cliSpinners; | ||
}; | ||
export = cliSpinners; |
@@ -6,2 +6,3 @@ 'use strict'; | ||
module.exports = spinners; | ||
// TODO: Remove this for the next major release | ||
module.exports.default = spinners; |
{ | ||
"name": "cli-spinners", | ||
"version": "2.0.0", | ||
"version": "2.1.0", | ||
"description": "Spinners for use in the terminal", | ||
@@ -16,3 +16,3 @@ "license": "MIT", | ||
"scripts": { | ||
"test": "xo && ava && tsd-check", | ||
"test": "xo && ava && tsd", | ||
"asciicast": "asciinema rec --command='node example-all.js' --title='cli-spinner' --quiet" | ||
@@ -43,7 +43,7 @@ }, | ||
"devDependencies": { | ||
"ava": "^1.2.1", | ||
"log-update": "^2.1.0", | ||
"tsd-check": "^0.3.0", | ||
"ava": "^1.4.1", | ||
"log-update": "^3.2.0", | ||
"tsd": "^0.7.2", | ||
"xo": "^0.24.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
16032
1018