# promise-queue-easy

> queue promise

Latest version **1.0.7** (published 2019-10-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install promise-queue-easy
pnpm add promise-queue-easy
yarn add promise-queue-easy
bun add promise-queue-easy
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.7 |
| Published | 2019-10-14 |
| First published | 2019-01-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 115 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | kele |
| Maintainers | kele |
| Keywords | promise queue, promise-queue-easy, queue, promise, queue-promise, promise-queue |

## Links

- npm: https://www.npmjs.com/package/promise-queue-easy
- Repository: https://github.com/kokokele/promise.queue
- Homepage: https://github.com/kokokele/promise.queue#readme
- Issues: https://github.com/kokokele/promise.queue/issues
- npm.io page: https://npm.io/package/promise-queue-easy

## Alternatives

- [cron](https://npm.io/package/cron.md) — 4.9M weekly downloads
- [@vercel/queue](https://npm.io/package/@vercel/queue.md) — 731.6K weekly downloads
- [create-sonicjs](https://npm.io/package/create-sonicjs.md) — 1.6K weekly downloads
- [@exellix/jobs-api](https://npm.io/package/@exellix/jobs-api.md) — 941 weekly downloads
- [@forwardimpact/libskill](https://npm.io/package/@forwardimpact/libskill.md) — 575 weekly downloads

## Recent versions

- 1.0.7 (latest) — 2019-10-14
- 1.0.6 — 2019-01-15
- 1.0.5 — 2019-01-14
- 1.0.4 — 2019-01-09
- 1.0.3 — 2019-01-08
- 1.0.2 — 2019-01-08
- 1.0.1 — 2019-01-07
- 1.0.0 — 2019-01-07

## README

# Promise.queue
[![NPM](https://nodei.co/npm/promise-queue-easy.png)](https://nodei.co/npm/promise-queue-easy/)
[![Build Status](https://travis-ci.org/kokokele/promise.queue.svg?branch=master)](https://travis-ci.org/kokokele/promise.queue.svg?branch=master)
[![codecov](https://codecov.io/gh/kokokele/promise.queue/branch/master/graph/badge.svg)](https://codecov.io/gh/kokokele/promise.queue)
[![NPM Version](https://img.shields.io/npm/v/promise-queue-easy.svg?style=flat)](https://img.shields.io/npm/v/promise-queue-easy.svg?style=flat)
[![Dowload](https://img.shields.io/npm/dm/promise-queue-easy.svg)](https://npmcharts.com/compare/promise-queue-easy?minimal=true&interval=30)
![Total visitor](https://visitor-count-badge.herokuapp.com/total.svg?repo_id=kokokele.promise.queue)
![Visitors in today](https://visitor-count-badge.herokuapp.com/today.svg?repo_id=kokokele.promise.queue)

## support
- AMD
- CommonJS
- Browser

## install
```
npm i promise-queue-easy
or
yarn add promise-queue-easy
```

## test
```
npm run test
```

## Example

```js
const QueuePromise = require('promise-queue-easy');

let p1 = () => {
  return new Promise((resolve, reject) => {
    setTimeout(() => {
      resolve('p1 success;');
    }, 1000);
  });
}

let p2 = () => {
  return new Promise((resolve, reject) => {
    // resolve('success')
    setTimeout(() => {
      reject('p2 error;');
    }, 100)
  });
}

let p3 = () =>  new Promise((resolve, reject) => {
  resolve('p3 success;')
});



const qp = new QueuePromise([p1, p2, p3], {
  callback: function() {
    console.log('===all done===');
  },
  errorInterrupt: false
});

qp.on('success', (res, index) => {
  // res
});
qp.on('error', (err, index) => {
  //err
})

qp.run();
```

## doc

####  new QueuePromise(queue, options):
```
 queue : promise queue,
 options: {
  callback: Function //(results) => {}  all done callback,
  errorInterrupt: Boolean // True stops subsequent execution when an error is encountered and vice versa
 }
```

#### methods:

- on(event, handle): `each execution call`

```
event: String ('success' or 'error');
hanlde: Function
```

- add(fun：Function) 
`add promise in queue`

- pause():
`pasue execute`

- resume():
` resume queue execute`

- get running :
 `return Boolean `

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