loading-indicator
Simple and customizable command line loading indicator
Install
Warning: v2.0.0
is a complete rewrite of the previous implementation.
$ npm install loading-indicator --save
Usage
; // Initialize the loading animation and saves the timer idconst timer = loadingstart; // 1500ms later, stop the loading animation passing along the timer id;
Presets
;// Import available presets; // Use an available preset (or simply provides an array with your custom preset)const timer = loadingstartnull frames: presetsarrows;
Custom text
; // Setup a custom loading textconst timer = loadingstart'Loading...';
API
loading.start([text], [options])
Returns a number
with the id that is used to reset the render interval (later referenced as timer).
text
Type: string
Default: null
Text do append to the indicator symbol.
options
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:
loading.stop(timer, [shouldKeepOutput])
timer
Required
Type: number
(integer)
Id of the render function interval.
shouldKeepOutput
Type: boolean
Default: false
Whether or not to keep the output when loading.stop()
is called.
License
MIT ©️ Rafael Rinaldi