https://github.com/chinanf-boy/ora-min
code: Copy from <ora>, but min - change { chalk -> turbocolor} ✅ check>
https://github.com/chinanf-boy/ora-min
min ora turbocolor
Last synced: about 1 year ago
JSON representation
code: Copy from <ora>, but min - change { chalk -> turbocolor} ✅ check>
- Host: GitHub
- URL: https://github.com/chinanf-boy/ora-min
- Owner: chinanf-boy
- License: mit
- Created: 2018-08-20T04:07:39.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2018-08-20T04:17:36.000Z (almost 8 years ago)
- Last Synced: 2024-04-26T04:03:12.599Z (about 2 years ago)
- Topics: min, ora, turbocolor
- Language: JavaScript
- Homepage: https://bundlephobia.com/result?p=ora-min
- Size: 385 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
README
# ora-min [](https://travis-ci.org/sindresorhus/ora)
Elegant terminal spinner
> `ora` is good, but `chalk` is big, and so many method/color that i no use
## live:me
[help me live , live need money 💰](https://github.com/chinanf-boy/live-need-money)
## Install
```
npm install ora-min
```
> sindresorhus 's patreon
## Usage
```js
const ora = require('ora-min');
const spinner = ora('Loading unicorns').start();
setTimeout(() => {
spinner.color = 'yellow';
spinner.text = 'Loading rainbows';
}, 1000);
```
## API
### ora([options|text])
If a string is provided, it is treated as a shortcut for [`options.text`](#text).
#### options
Type: `Object`
##### text
Type: `string`
Text to display after the spinner.
##### spinner
Type: `string` `Object`
Default: `dots` 
Name of one of the [provided spinners](https://github.com/sindresorhus/cli-spinners/blob/master/spinners.json). See `example.js` in this repo if you want to test out different spinners.
Or an object like:
```js
{
interval: 80, // optional
frames: ['-', '+', '-']
}
```
##### color
Type: `string`
Default: `cyan`
Values: `black` `red` `green` `yellow` `blue` `magenta` `cyan` `white` `gray`
Color of the spinner.
##### hideCursor
Type: `boolean`
Default: `true`
Set to `false` to stop Ora from hiding the cursor.
##### interval
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.
##### stream
Type: `WritableStream`
Default: `process.stderr`
Stream to write the output.
You could for example set this to `process.stdout` instead.
##### isEnabled
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.
### Instance
#### .start([text])
Start the spinner. Returns the instance. Set the current text if `text` is provided.
#### .stop()
Stop and clear the spinner. Returns the instance.
#### .succeed([text])
Stop the spinner, change it to a green `✔` and persist the current text, or `text` if provided. Returns the instance. See the GIF below.
#### .fail([text])
Stop the spinner, change it to a red `✖` and persist the current text, or `text` if provided. Returns the instance. See the GIF below.
#### .warn([text])
Stop the spinner, change it to a yellow `⚠` and persist the current text, or `text` if provided. Returns the instance.
#### .info([text])
Stop the spinner, change it to a blue `ℹ` and persist the current text, or `text` if provided. Returns the instance.
#### .isSpinning
A boolean of whether the instance is currently spinning.
#### .stopAndPersist([options])
Stop the spinner and change the symbol or text. Returns the instance. See the GIF below.
##### options
Type: `Object`
###### symbol
Type: `string`
Default: `' '`
Symbol to replace the spinner with.
###### text
Type: `string`
Default: Current text
Text to be persisted.
#### .clear()
Clear the spinner. Returns the instance.
#### .render()
Manually render a new frame. Returns the instance.
#### .frame()
Get a new frame.
#### .text
Change the text.
#### .color
Change the spinner color.
### ora.promise(action, [options|text])
Starts a spinner for a promise. The spinner is stopped with `.succeed()` if the promise fulfills or with `.fail()` if it rejects. Returns the spinner instance.
#### action
Type: `Promise`
## Related
- [cli-spinners](https://github.com/sindresorhus/cli-spinners) - Spinners for use in the terminal
- [listr](https://github.com/SamVerschueren/listr) - Terminal task list
- [CLISpinner](https://github.com/kiliankoe/CLISpinner) - Terminal spinner library for Swift
- [halo](https://github.com/ManrajGrover/halo) - Python port
- [spinners](https://github.com/FGRibreau/spinners) - Terminal spinners for Rust
- [marquee-ora](https://github.com/joeycozza/marquee-ora) - Scrolling marquee spinner for Ora
## License
MIT © [Sindre Sorhus](https://sindresorhus.com)