Gathering detailed insights and metrics for ora
Gathering detailed insights and metrics for ora
Gathering detailed insights and metrics for ora
Gathering detailed insights and metrics for ora
npm install ora
Typescript
Module System
Min. Node Version
Node Version
NPM Version
96.3
Supply Chain
99
Quality
81.6
Maintenance
100
Vulnerability
100
License
Updated on 06 Dec 2024
JavaScript (94.78%)
TypeScript (5.22%)
Cumulative downloads
Total Downloads
Last day
19.9%
Compared to previous day
Last week
-3.6%
Compared to previous week
Last month
4.9%
Compared to previous month
Last year
39.1%
Compared to previous year
Elegant terminal spinner
1npm install ora
Check out yocto-spinner
for a smaller alternative.
1import ora from 'ora'; 2 3const spinner = ora('Loading unicorns').start(); 4 5setTimeout(() => { 6 spinner.color = 'yellow'; 7 spinner.text = 'Loading rainbows'; 8}, 1000);
If a string is provided, it is treated as a shortcut for options.text
.
Type: object
Type: string
The text to display next to the spinner.
Type: string | () => string
Text or a function that returns text to display before the spinner. No prefix text will be displayed if set to an empty string.
Type: string | () => string
Text or a function that returns text to display after the spinner text. No suffix text will be displayed if set to an empty string.
Type: string | object
Default: 'dots'
The name of one of the provided 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.
Or an object like:
1{ 2 frames: ['-', '+', '-'], 3 interval: 80 // Optional 4}
Type: string
Default: 'cyan'
Values: 'black' | 'red' | 'green' | 'yellow' | 'blue' | 'magenta' | 'cyan' | 'white' | 'gray'
The color of the spinner.
Type: boolean
Default: true
Set to false
to stop Ora from hiding the cursor.
Type: number
Default: 0
Indent the spinner with the given number of spaces.
Type: number
Default: Provided by the spinner or 100
Interval between each frame.
Spinners provide their own recommended interval, so you don't really need to specify this.
Type: stream.Writable
Default: process.stderr
Stream to write the output.
You could for example set this to process.stdout
instead.
Type: boolean
Force enable/disable the spinner. If not specified, the spinner will be enabled if the stream
is being run inside a TTY context (not spawned or piped) and/or not in a CI environment.
Note that {isEnabled: false}
doesn't mean it won't output anything. It just means it won't output the spinner, colors, and other ansi escape codes. It will still log text.
Type: boolean
Default: false
Disable the spinner and all log text. All output is suppressed and isEnabled
will be considered false
.
Type: boolean
Default: true
Discard stdin input (except Ctrl+C) while running if it's TTY. This prevents the spinner from twitching on input, outputting broken lines on Enter key presses, and prevents buffering of input while the spinner is running.
This has no effect on Windows as there is no good way to implement discarding stdin properly there.
Change the text displayed after the spinner.
Change the text before the spinner.
No prefix text will be displayed if set to an empty string.
Change the text after the spinner text.
No suffix text will be displayed if set to an empty string.
Change the spinner color.
Change the spinner.
Change the spinner indent.
A boolean indicating whether the instance is currently spinning.
The interval between each frame.
The interval is decided by the chosen spinner.
Start the spinner. Returns the instance. Set the current text if text
is provided.
Stop and clear the spinner. Returns the instance.
Stop the spinner, change it to a green ✔
and persist the current text, or text
if provided. Returns the instance. See the GIF below.
Stop the spinner, change it to a red ✖
and persist the current text, or text
if provided. Returns the instance. See the GIF below.
Stop the spinner, change it to a yellow ⚠
and persist the current text, or text
if provided. Returns the instance.
Stop the spinner, change it to a blue ℹ
and persist the current text, or text
if provided. Returns the instance.
Stop the spinner and change the symbol or text. Returns the instance. See the GIF below.
Type: object
Type: string
Default: ' '
Symbol to replace the spinner with.
Type: string
Default: Current 'text'
Text to be persisted after the symbol.
Type: string | () => string
Default: Current prefixText
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.
Type: string | () => string
Default: Current suffixText
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.
Clear the spinner. Returns the instance.
Manually render a new frame. Returns the instance.
Get a new frame.
Starts a spinner for a promise or promise-returning function. The spinner is stopped with .succeed()
if the promise fulfills or with .fail()
if it rejects. Returns the promise.
1import {oraPromise} from 'ora'; 2 3await oraPromise(somePromise);
Type: Promise | ((spinner: ora.Ora) => Promise)
Type: object
All of the options plus the following:
Type: string | ((result: T) => string) | undefined
The new text of the spinner when the promise is resolved.
Keeps the existing text if undefined
.
Type: string | ((error: Error) => string) | undefined
The new text of the spinner when the promise is rejected.
Keeps the existing text if undefined
.
Type: Record<string, Spinner>
All provided spinners.
Use chalk
or yoctocolors
:
1import ora from 'ora'; 2import chalk from 'chalk'; 3 4const spinner = ora(`Loading ${chalk.red('unicorns')}`).start();
JavaScript is single-threaded, so any synchronous operations will block the spinner's animation. To avoid this, prefer using asynchronous operations.
Ports
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
security policy file detected
Details
Reason
0 existing vulnerabilities detected
Reason
license file detected
Details
Reason
3 commit(s) and 1 issue activity found in the last 90 days -- score normalized to 3
Reason
Found 5/30 approved changesets -- score normalized to 1
Reason
detected GitHub workflow tokens with excessive permissions
Details
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
project is not fuzzed
Details
Reason
branch protection not enabled on development/release branches
Details
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
Score
Last Scanned on 2024-11-25
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More