ora - npm Package Compare versions
Comparing version 8.0.1 to 8.1.0
@@ -25,3 +25,3 @@ import {type SpinnerName} from 'cli-spinners'; | ||
| /** | ||
| Text to display after the spinner. | ||
| The text to display next to the spinner. | ||
| */ | ||
@@ -41,3 +41,3 @@ readonly text?: string; | ||
| /** | ||
| Name of one of the provided spinners. See [`example.js`](https://github.com/BendingBender/ora/blob/main/example.js) in this repo if you want to test out different spinners. On Windows, it will always use the line spinner as the Windows command-line doesn't have proper Unicode support. | ||
| The name of one of the provided spinners. See [`example.js`](https://github.com/BendingBender/ora/blob/main/example.js) in this repo if you want to test out different spinners. On Windows (expect for Windows Terminal), it will always use the line spinner as the Windows command-line doesn't have proper Unicode support. | ||
@@ -51,4 +51,4 @@ @default 'dots' | ||
| { | ||
| interval: 80, // Optional | ||
| frames: ['-', '+', '-'] | ||
| frames: ['-', '+', '-'], | ||
| interval: 80 // Optional | ||
| } | ||
@@ -210,3 +210,3 @@ ``` | ||
| /** | ||
| A boolean of whether the instance is currently spinning. | ||
| A boolean indicating whether the instance is currently spinning. | ||
| */ | ||
@@ -213,0 +213,0 @@ get isSpinning(): boolean; |
@@ -28,3 +28,2 @@ import process from 'node:process'; | ||
| #suffixText; | ||
| color; | ||
@@ -31,0 +30,0 @@ |
| { | ||
| "name": "ora", | ||
| "version": "8.0.1", | ||
| "version": "8.1.0", | ||
| "description": "Elegant terminal spinner", | ||
@@ -47,3 +47,3 @@ "license": "MIT", | ||
| "chalk": "^5.3.0", | ||
| "cli-cursor": "^4.0.0", | ||
| "cli-cursor": "^5.0.0", | ||
| "cli-spinners": "^2.9.2", | ||
@@ -53,14 +53,14 @@ "is-interactive": "^2.0.0", | ||
| "log-symbols": "^6.0.0", | ||
| "stdin-discarder": "^0.2.1", | ||
| "string-width": "^7.0.0", | ||
| "stdin-discarder": "^0.2.2", | ||
| "string-width": "^7.2.0", | ||
| "strip-ansi": "^7.1.0" | ||
| }, | ||
| "devDependencies": { | ||
| "@types/node": "^20.10.5", | ||
| "@types/node": "^22.5.0", | ||
| "ava": "^5.3.1", | ||
| "get-stream": "^8.0.1", | ||
| "get-stream": "^9.0.1", | ||
| "transform-tty": "^1.0.11", | ||
| "tsd": "^0.30.0", | ||
| "xo": "^0.56.0" | ||
| "tsd": "^0.31.1", | ||
| "xo": "^0.59.3" | ||
| } | ||
| } |
@@ -17,2 +17,4 @@ # ora | ||
| *Check out [`yocto-spinner`](https://github.com/sindresorhus/yocto-spinner) for a smaller alternative.* | ||
| ## Usage | ||
@@ -46,3 +48,3 @@ | ||
| Text to display after the spinner. | ||
| The text to display next to the spinner. | ||
@@ -66,3 +68,3 @@ ##### prefixText | ||
| Name of one of the [provided spinners](#spinners). See `example.js` in this repo if you want to test out different spinners. On Windows, it will always use the `line` spinner as the Windows command-line doesn't have proper Unicode support. | ||
| The name of one of the [provided spinners](#spinners). See `example.js` in this repo if you want to test out different spinners. On Windows (except for Windows Terminal), it will always use the `line` spinner as the Windows command-line doesn't have proper Unicode support. | ||
@@ -73,4 +75,4 @@ Or an object like: | ||
| { | ||
| interval: 80, // Optional | ||
| frames: ['-', '+', '-'] | ||
| frames: ['-', '+', '-'], | ||
| interval: 80 // Optional | ||
| } | ||
@@ -147,3 +149,3 @@ ``` | ||
| Change the text after the spinner. | ||
| Change the text displayed after the spinner. | ||
@@ -176,3 +178,3 @@ #### .prefixText <sup>get/set</sup> | ||
| A boolean of whether the instance is currently spinning. | ||
| A boolean indicating whether the instance is currently spinning. | ||
@@ -233,13 +235,13 @@ #### .interval <sup>get</sup> | ||
| Type: `string`\ | ||
| Type: `string | () => string`\ | ||
| Default: Current `prefixText` | ||
| Text to be persisted before the symbol. No prefix text will be displayed if set to an empty string. | ||
| Text or a function that returns text to be persisted before the symbol. No prefix text will be displayed if set to an empty string. | ||
| ###### suffixText | ||
| Type: `string`\ | ||
| Type: `string | () => string`\ | ||
| Default: Current `suffixText` | ||
| Text to be persisted after the text after the symbol. No suffix text will be displayed if set to an empty string. | ||
| Text or a function that returns text to be persisted after the text after the symbol. No suffix text will be displayed if set to an empty string. | ||
@@ -307,3 +309,3 @@ <img src="screenshot-2.gif" width="480"> | ||
| Use [Chalk](https://github.com/chalk/chalk): | ||
| Use [`chalk`](https://github.com/chalk/chalk) or [`yoctocolors`](https://github.com/sindresorhus/yoctocolors): | ||
@@ -319,8 +321,11 @@ ```js | ||
| JavaScript is single-threaded, so synchronous operations blocks the thread, including the spinner animation. Prefer asynchronous operations whenever possible. | ||
| JavaScript is single-threaded, so any synchronous operations will block the spinner's animation. To avoid this, prefer using asynchronous operations. | ||
| ## Related | ||
| - [yocto-spinner](https://github.com/sindresorhus/yocto-spinner) - Tiny terminal spinner | ||
| - [cli-spinners](https://github.com/sindresorhus/cli-spinners) - Spinners for use in the terminal | ||
| - [listr](https://github.com/SamVerschueren/listr) - Terminal task list | ||
| **Ports** | ||
| - [CLISpinner](https://github.com/kiliankoe/CLISpinner) - Terminal spinner library for Swift | ||
@@ -333,3 +338,2 @@ - [halo](https://github.com/ManrajGrover/halo) - Python port | ||
| - [observablehq.com/@victordidenko/ora](https://observablehq.com/@victordidenko/ora) - Ora port to Observable notebooks | ||
| - [spinnies](https://github.com/jcarpanelli/spinnies) - Terminal multi-spinner library for Node.js | ||
| - [kia](https://github.com/HarryPeach/kia) - Simple terminal spinners for Deno 🦕 |
New alerts
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
Fixed alerts
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
Improved metrics
- Total package byte prevSize
- increased by1.08%
27096
- Lines of code
- increased by0.17%
575
- Number of lines in readme file
- increased by1.23%
330
Dependency changes
+ Addedcli-cursor@5.0.0(transitive)
+ Addedmimic-function@5.0.1(transitive)
+ Addedonetime@7.0.0(transitive)
+ Addedrestore-cursor@5.1.0(transitive)
+ Addedsignal-exit@4.1.0(transitive)
- Removedcli-cursor@4.0.0(transitive)
- Removedmimic-fn@2.1.0(transitive)
- Removedonetime@5.1.2(transitive)
- Removedrestore-cursor@4.0.0(transitive)
- Removedsignal-exit@3.0.7(transitive)
Updatedcli-cursor@^5.0.0
Updatedstdin-discarder@^0.2.2
Updatedstring-width@^7.2.0