loading-indicator 

> Simple and customizable command line loading indicator

Install

Warning: v2.0.0 is a complete rewrite of the previous implementation.
``sh
$ npm install loading-indicator --save
`

Usage

`js
import loading from 'loading-indicator';

// Initialize the loading animation and saves the timer id
const timer = loading.start();

// 1500ms later, stop the loading animation passing along the timer id
setTimeout(() => {
loading.stop(timer);
}, 1500);
`

!demo-default

$3

`js
import loading from 'loading-indicator';
// Import available presets
import presets from 'loading-indicator/presets';

// Use an available preset (or simply provides an array with your custom preset)
const timer = loading.start(null, {
frames: presets.arrows
});
`

!demo-presets

$3

`js
import loading from 'loading-indicator';

// Setup a custom loading text
const timer = loading.start('Loading...');
`

!demo-custom-text

API

loading.start([text], [options])

Returns a number with the id that is used to reset the render interval (later referenced as _timer_).

$3

Type: string
Default: null

Text do append to the indicator symbol.

$3

Type: object

Available options.

#### options.delay

Type: number _(milliseconds)_
Default: 100

Delay for the render to be triggered.

#### options.frames

Type: array
Default: presets.spinner

Frames for the loading animation sequence.

Available presets are:

* spinner (default)
* circle
* dots
* bullets
* arrows
* clock

loading.stop(timer, [shouldKeepOutput])

$3

_Required_
Type: number _(integer)_

Id of the render function interval.

$3

Type: boolean
Default: false

Whether or not to keep the output when loading.stop()` is called.

License

MIT :copyright: Rafael Rinaldi