Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/noblesamurai/promises-progress

Progress reporting for array of promises.
https://github.com/noblesamurai/promises-progress

Last synced: about 1 month ago
JSON representation

Progress reporting for array of promises.

Awesome Lists containing this project

README

        

# Promises-progress [![Build Status](https://secure.travis-ci.org/noblesamurai/promises-progress.png?branch=master)](http://travis-ci.org/noblesamurai/promises-progress) [![NPM version](https://badge-me.herokuapp.com/api/npm/promises-progress.png)](http://badges.enytc.com/for/npm/promises-progress)

> Wrap an array of promises to call a progress function.

## Purpose
Progress notification as promises in an array resolve.

## Usage

```js
const promisesProgress = require('promises-progress');
const promises = [/* my array of promises */];
const wrappedPromises = promisesProgress(promises, (progress) => {/* do stuff on progress notification */});
```

## Installation

This module is installed via npm:

``` bash
$ npm install promises-progress
```

## Contributing

### Prerequisites

```
$ pip install pre-commit
```

### Installation

```
$ pre-commit install --install-hooks
```

## License

The BSD License

Copyright (c) 2018, Tim Allen

All rights reserved.

Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution.

* Neither the name of the Tim Allen nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.