Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/codekirei/node-multispinner
Multiple, simultaneous, individually controllable spinners for concurrent tasks in Node.js CLI programs
https://github.com/codekirei/node-multispinner
Last synced: 3 months ago
JSON representation
Multiple, simultaneous, individually controllable spinners for concurrent tasks in Node.js CLI programs
- Host: GitHub
- URL: https://github.com/codekirei/node-multispinner
- Owner: codekirei
- License: mit
- Created: 2015-10-13T06:14:25.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2020-04-01T00:05:11.000Z (almost 5 years ago)
- Last Synced: 2024-09-18T03:19:03.653Z (4 months ago)
- Language: JavaScript
- Homepage:
- Size: 146 KB
- Stars: 295
- Watchers: 5
- Forks: 24
- Open Issues: 6
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
- awesome-nodejs-cn - multispinner - 多样的、可同时独立控制的 CLI 旋转指示器 (包 / 命令行工具)
- awesome-nodejs - multispinner - Multiple, simultaneous, individually controllable CLI spinners. (Packages / Command-line utilities)
- awesome-nodejs - node-multispinner - Multiple, simultaneous, individually controllable spinners for concurrent tasks in Node.js CLI programs - ★ 226 (Command-line utilities)
- awesome-node - multispinner - Multiple, simultaneous, individually controllable CLI spinners. (Packages / Command-line utilities)
- awesome-nodejs-cn - multispinner - 多个可同时单独控制的CLI进度加载器. (目录 / 命令行工具)
- awesome-nodejs-cn - multispinner - **star:296** 多个，同时，单独控制的CLI spinners (包 / 命令行实用工具)
README
---
[![Build Status][1]][2]
[![Coverage Status][3]][4]
[About](#about) |
[Installation](#installation) |
[API](#api) |
[Examples](#examples) |
[Attribution](#attribution) |
[License](#license)
## About
`node-multispinner` is a [Node.js](https://nodejs.org/) module for managing multiple progress indicators (spinners) in CLI apps.
This module is especially useful for apps that benefit from simultaneous async task execution (e.g. with `Promise.all[]`), as it enables live updating individual spinners, in any order, while other spinners continue spinning.
Node.js 4.0 or newer is required.
## Installation
Install and require as a standard Node module.
**Install**
```
$ npm install --save multispinner
```
**Require**
```js
var Multispinner = require('multispinner')
```
## API
Full documentation available [here](https://github.com/codekirei/node-multispinner/blob/master/extras/api.md).
## Examples
The examples discussed below can be found [here](https://github.com/codekirei/node-multispinner/tree/master/extras/examples).
Run them in a terminal with node:
```
$ node
```
**Example:** `events.js`
Creates four spinners from an array, then completes them in succession with staggered `setTimeout` functions.
Responds to the `success` and `err` completion events.
**Example:** `customAnimation.js`
Creates a custom spinner animation with the `frames` option.
**Example:** `randomInfiniteLoop.js`
Creates three to seven spinners with random lorem text and completes them randomly in less than five seconds in an infinite loop.
Stubs out the `logUpdate.done()` function to overwrite the previous output with every loop.
It's kind of mesmerising.
**Example:** `cli-with-promises`
A CLI application that reads URLs and parses HTML into text to display in a terminal.
Uses [meow](https://github.com/sindresorhus/meow) for CLI support, [html-to-text](https://github.com/werk85/node-html-to-text) for parsing, and [axios](https://github.com/mzabriskie/axios) for Promise-based HTTP requests.
Creates spinners for each URL, and uses `Promise.all()` to execute the GET requests in parallel.
There are certainly edge cases that this example doesn't account for; it is not meant to be a "real" application.
Despite that, the code should be illustrative of how `node-multispinner` could potentially be used in a real application.
This example is unique in that it requires modules not used in `node-multispinner`.
Before running it, `cd` into its directory and install the additional requirements from its `package.json` with `npm install`.
## Attribution
Thanks to [sindresorhus](https://sindresorhus.com/hi/) for his [log-update](https://github.com/sindresorhus/log-update) module, which was a major inspiration for and is used extensively in this module.
Log-update is [MIT licensed](https://raw.githubusercontent.com/sindresorhus/log-update/master/license).
## License
[MIT](https://github.com/codekirei/node-multispinner/blob/master/license)
[1]: https://img.shields.io/travis/codekirei/node-multispinner.svg?style=flat-square
[2]: https://travis-ci.org/codekirei/node-multispinner
[3]: http://img.shields.io/coveralls/codekirei/node-multispinner.svg?style=flat-square
[4]: https://coveralls.io/github/codekirei/node-multispinner?branch=master