# io-spin

> TJ Holowaychuk's go-spin node.js port

Latest version **0.4.1** (published 2016-09-08) · MIT license · 0 weekly downloads

## Install

```sh
npm install io-spin
pnpm add io-spin
yarn add io-spin
bun add io-spin
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.4.1 |
| Published | 2016-09-08 |
| First published | 2015-02-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 125 |
| Author | EGOIST |
| Maintainers | 0x142857, kchan |
| Keywords | spin, tj, terminal |

## Links

- npm: https://www.npmjs.com/package/io-spin
- Repository: https://github.com/egoist/io-spin
- Issues: https://github.com/egoist/io-spin/issues
- npm.io page: https://npm.io/package/io-spin

## Alternatives

- [localforage](https://npm.io/package/localforage.md) — 6.2M weekly downloads
- [localforage-observable](https://npm.io/package/localforage-observable.md) — 30.8K weekly downloads
- [@y/y](https://npm.io/package/@y/y.md) — 30.1K weekly downloads
- [@metaobjectsdev/render](https://npm.io/package/@metaobjectsdev/render.md) — 3.5K weekly downloads
- [@ledgerhq/coin-algorand](https://npm.io/package/@ledgerhq/coin-algorand.md) — 1.1K weekly downloads

## Recent versions

- 0.4.1 (latest) — 2016-09-08
- 0.4.0 — 2016-08-27
- 0.3.0 — 2016-01-27
- 0.2.2 — 2015-12-21
- 0.2.1 — 2015-12-20
- 0.2.0 — 2015-12-20
- 0.1.2 — 2015-02-26
- 0.1.1 — 2015-02-26
- 0.1.0 — 2015-02-21

## README

# io-spin

[![NPM version](https://img.shields.io/npm/v/io-spin.svg)](https://www.npmjs.com/package/io-spin)
[![NPM download](https://img.shields.io/npm/dm/io-spin.svg)](https://www.npmjs.com/package/io-spin)
[![Build Status: Linux](https://travis-ci.org/egoist/io-spin.svg?branch=master)](https://travis-ci.org/egoist/io-spin)

Little terminal spinner lib for Node.js and io.js

![io-spin.gif](https://ooo.0o0.ooo/2015/12/20/567768f40ac91.gif)

## Installation

```bash
$ npm install io-spin
```

## Example

```javascript
var spin = require('io-spin')
var spinner = spin('Fetching data')

spinner.start()
spinner.stop()
spinner.update(placeholder)
// upload placeholder
// eg: update Installing 0% to Installing 1%
```

## API

### spin(placeholder, type)

#### placeholder

Type: `string`<br>
Default: `''`

The placeholder to show with the spinner.

#### type

Type: `string`<br>
Default: `spin1`

The spinner type. [Checkout all the spinner types!](/spinners.json)

### .start

Start the spinner.

### .stop

Stop the spinner and clear it.

### .update(placeholder)

Update the placeholder text.

## GIF (original from tj/go-spin)

![gif](https://raw.githubusercontent.com/tj/go-spin/master/go-spin.gif)

## License

MIT &copy; [EGOIST](https://github.com/egoist)

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