JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 20842
  • Score
    100M100P100Q169562F
  • License MIT

Loading spinner for NodeJS.

Package Exports

  • loading-spinner

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (loading-spinner) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

loading-spinner

Loading spinner for NodeJS.

NPM

The MIT License npm Travis David David

Known Vulnerabilities

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

FOSSA Status