loading-spinner
Version:
Loading spinner for NodeJS.
69 lines (46 loc) • 2.55 kB
Markdown
# loading-spinner
Loading spinner for NodeJS.
[](https://nodei.co/npm/loading-spinner/)
[](http://opensource.org/licenses/MIT)
[](https://www.npmjs.com/package/loading-spinner)
[](https://travis-ci.org/ivangabriele/loading-spinner)
[](https://david-dm.org/ivangabriele/loading-spinner)
[](https://david-dm.org/ivangabriele/loading-spinner)
[](https://snyk.io/test/github/ivangabriele/loading-spinner)
---
## Installation
npm install --save loading-spinner
## Usage
var loadingSpinner = require('loading-spinner');
// Start the loading spinner
loadingSpinner.start(
[Integer, default: 100], // Interval (in ms) between each spinner sequence element
{
clearChar: [Boolean, default: false], // Clear the spinner when stop() is called
clearLine: [Boolean, default: false], // Clear the entire line when stop() is called
doNotBlock: [Boolean, default: false], // Does not prevent the process from exiting
hideCursor: [Boolean, default: false] // Hide the cursor until stop() is called
}
);
// Stop the loading spinner
loadingSpinner.stop();
// Customize the spinner sequence
loadingSpinner.setSequence(
[Array, default: ['|','/','-','\\']], // Sequence of spinner elements
);
## Example
var loadingSpinner = require('loading-spinner');
var dary = function() {
loadingSpinner.stop();
process.stdout.write('DA-RY !');
};
var legend = function() {
process.stdout.write('It\'s gonna be LE-GEN... Wait for it... ');
loadingSpinner.start(100, {
clearChar: true
});
setTimeout(dary, 1000);
};
legend();
## Licenses
[](https://app.fossa.io/projects/git%2Bgithub.com%2Fivangabriele%2Floading-spinner?ref=badge_large)