cli-loading-animation

This library combines cli-spinners and log-update to display a loading animation in CLI apps made with Node.

Install

1# NPM
2npm install cli-loading-animation
3
4# Yarn
5yarn add cli-loading-animation

Example

1const { loading } = require('cli-loading-animation');
2
3const { start, stop } = loading('Loading..');
4
5start();
6
7setTimeout(() => stop(), 3000);

Custom Spinner

1const { loading } = require('cli-loading-animation');
2const spinners = require('cli-spinners');
3
4const { start, stop } = loading('Loading..', { clearOnEnd: false, spinner: spinners.bouncingBall });
5
6start();
7
8setTimeout(() => stop(), 3000);

Where spinner can be a object with frames (an array of strings) and interval (a number) property.

The library cli-spinners already provide several spinners in this format.

Options

Option	Description	Default Value
spinner	Custom Spinner to use	dots from the cli-spinners library
clearOnEnd	Specifies if the loading line on the console must be cleared on calling the stop function.	true

License

MIT