Simple and customizable command line loading indicator
Warning: v2.0.0
is a complete rewrite of the previous implementation.
$ npm install loading-indicator --save
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);
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
});
import loading from 'loading-indicator';
// Setup a custom loading text
const timer = loading.start('Loading...');
Returns a number
with the id that is used to reset the render interval (later referenced as timer).
Type: string
Default: null
Text do append to the indicator symbol.
Type: object
Available options.
Type: number
(milliseconds)
Default: 100
Delay for the render to be triggered.
Type: array
Default: presets.spinner
Frames for the loading animation sequence.
Available presets are:
Required
Type: number
(integer)
Id of the render function interval.
Type: boolean
Default: false
Whether or not to keep the output when loading.stop()
is called.
MIT ©️ Rafael Rinaldi