JSPM

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

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

This is a supper simple spinner / activity indicator for Node.js. I've used it in a few console tools that I've written in Node.js, where I've wanted to show that there is activity and that the program isn't hung.

NPM

How Simple Is It?

So simple it only has 3 functions.

  • start([interval in ms], [options])
    • Obviously this starts the spinner. You can give it how quickly you want it to go through the sequence of characters. Defaults to 250ms.
    • Update (2015-07-24): start can now also take an options object with the following keys:
      • hideCursor (boolean, default: false): When true, hide the console cursor (uses TooTallNate/ansi.js)
      • doNotBlock (boolean, default: false): When true, unref the timer so it does not prevent the process from exiting.
  • stop()
    • I really shouldn't have to explain this one...
  • change_sequence(sequence)
    • Use this if you don't like the default spinning stick. Give it an array of strings like this [".", "o", "0", "@", "*"]