Install

With npm

1npm i tora-spinner

With yarn

1yarn add tora-spinner

Usage

1import tora from "tora-spinner";
2
3const spinner = tora({ text: "Loading…" });
4
5async function main() {
6  await spinner.start();
7
8  // Do some work
9  await new Promise((resolve) => setTimeout(resolve, 1000));
10
11  await spinner.stop("Stopped.");
12
13  // Kill spinner worker thread
14  spinner.terminate();
15}
16
17main();

API

tora(options?)

Creates a new spinner instance.

options

Type: object

text

Type: string
Default: ''

The text to display next to the spinner.

spinner

Type: object
Default:

Customize the spinner animation with a custom set of frames and interval.

1{
2	frames: ['-', '\\', '|', '/'],
3	interval: 100,
4}

Pass in any spinner from cli-spinners.

color

Type: string
Default: 'cyan'
Values: 'black' | 'red' | 'green' | 'yellow' | 'blue' | 'magenta' | 'cyan' | 'white' | 'gray'

The color of the spinner.

stream

Type: stream.Writable
Default: process.stderr

The stream to which the spinner is written.

Instance methods

.start(text?)

Starts the spinner.

Returns the instance.

Optionally, updates the text:

1spinner.start("Loading…");

.stop(finalText?)

Stops the spinner.

Returns the instance.

Optionally displays a final message.

1spinner.stop("Stopped.");

.success(text?)

Stops the spinner and displays a success symbol with the message.

Returns the instance.

1spinner.success("Success!");

.error(text?)

Stops the spinner and displays an error symbol with the message.

Returns the instance.

1spinner.error("Error!");

.warning(text?)

Stops the spinner and displays a warning symbol with the message.

Returns the instance.

1spinner.warning("Warning!");

.clear()

Clears the spinner.

Returns the instance.

.info(text?)

Stops the spinner and displays an info symbol with the message.

Returns the instance.

.terminate()

Kills the spinner worker thread.

Returns void.

1spinner.info("Info.");

.text ^get/set

Change the text displayed next to the spinner.

1spinner.text = "New text";

.color ^get/set

Change the spinner color.

.isSpinning ^get

Returns whether the spinner is currently spinning.

Credits

• ora - terminal spinner
• yocto-spinner - terminal spinner