# simple-spinner

> A super simple spinner

Latest version **0.0.5** (published 2015-07-27) · 0 weekly downloads

## Install

```sh
npm install simple-spinner
pnpm add simple-spinner
yarn add simple-spinner
bun add simple-spinner
```

## Health

**Score 10/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; low quality score; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.5 |
| Published | 2015-07-27 |
| First published | 2014-02-13 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 9 |
| Author | Ian McCall |
| Maintainers | dapuck |
| Keywords | simple, spinner, indicator |

## Links

- npm: https://www.npmjs.com/package/simple-spinner
- Repository: https://github.com/dapuck/node-simple-spinner
- Issues: https://github.com/dapuck/node-simple-spinner/issues
- npm.io page: https://npm.io/package/simple-spinner

## Dependencies (1)

- [ansi](https://npm.io/package/ansi.md) ^0.3.0

## Recent versions

- 0.0.5 (latest) — 2015-07-27
- 0.0.4 — 2015-07-24
- 0.0.3 — 2015-02-23
- 0.0.2 — 2014-08-20
- 0.0.1 — 2014-02-13

## README

Supper Simple Spinner for Node.js
=================================

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](https://nodei.co/npm/simple-spinner.png?downloads=true)](https://nodei.co/npm/simple-spinner/)

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", "@", "*"]`

---
_Source: https://npm.io/package/simple-spinner · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._