Skip to content

Commit

Permalink
1.0.2
Browse files Browse the repository at this point in the history
  • Loading branch information
ivoputzer committed Mar 20, 2017
1 parent c8aa922 commit 5875860
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 8 deletions.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "m.queue",
"version": "1.0.1",
"version": "1.0.2",
"description": "m(icro)queue is a lightweight es6+ library that exports an asynchronous function queue with adjustable concurrency",
"main": "index.js",
"scripts": {
Expand Down
25 changes: 18 additions & 7 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# m.queue
[![travis](https://img.shields.io/travis/ivoputzer/m.queue.svg?style=flat-square)](https://travis-ci.org/ivoputzer/m.queue) [![npm-dependencies](https://img.shields.io/badge/dependencies-none-blue.svg?style=flat-square&colorB=44CC11)](package.json) [![standard-js](https://img.shields.io/badge/coding%20style-standard-brightgreen.svg?style=flat-square)](http://standardjs.com/) [![coverage](https://coveralls.io/repos/github/ivoputzer/m.queue/badge.svg?branch=master)](https://coveralls.io/github/ivoputzer/m.queue?branch=master) [![npm-package-quality](http://npm.packagequality.com/shield/m.queue.svg?style=flat-square&colorB=44CC11)](http://packagequality.com/#?package=m.queue) [![npm-node-version](https://img.shields.io/badge/node-6%2B-blue.svg?style=flat-square)](https://nodejs.org/docs/v6.0.0/api) [![npm-version](https://img.shields.io/npm/v/m.queue.svg?style=flat-square&colorB=007EC6)](https://www.npmjs.com/package/m.queue) [![npm-license](https://img.shields.io/npm/l/m.queue.svg?style=flat-square&colorB=007EC6)](https://spdx.org/licenses/MIT)
[![ci](https://img.shields.io/travis/ivoputzer/m.queue.svg?style=flat-square)](https://travis-ci.org/ivoputzer/m.queue) [![dependencies](https://img.shields.io/badge/dependencies-none-blue.svg?style=flat-square&colorB=44CC11)](package.json) [![style](https://img.shields.io/badge/coding%20style-standard-brightgreen.svg?style=flat-square)](http://standardjs.com/) [![coverage](https://img.shields.io/coveralls/ivoputzer/m.queue.svg?style=flat-square)](https://coveralls.io/github/ivoputzer/m.queue?branch=master) [![quality](http://npm.packagequality.com/shield/m.queue.svg?style=flat-square&colorB=44CC11)](http://packagequality.com/#?package=m.queue) [![node](https://img.shields.io/badge/node-6%2B-blue.svg?style=flat-square)](https://nodejs.org/docs/v6.0.0/api) [![version](https://img.shields.io/npm/v/m.queue.svg?style=flat-square&colorB=007EC6)](https://www.npmjs.com/package/m.queue) [![license](https://img.shields.io/npm/l/m.queue.svg?style=flat-square&colorB=007EC6)](https://spdx.org/licenses/MIT)

**[m(icro)](https://github.com/ivoputzer/m.cro#readme)[queue](https://github.com/ivoputzer/m.queue)** is a lightweight es6+ library that exports an asynchronous function queue with adjustable concurrency.

## .async
## async
creates a `queue` object with the specified `concurrency`. tasks added to the queue are processed in parallel (up to the concurrency limit). if all `workers` are in progress, the task is queued until one becomes available. once a `worker` completes a task, that task's callback is called.

```javascript
Expand All @@ -19,14 +19,25 @@ const queue = async(function worker (arg0, arg1, callback) {
```

### queue.resume()
resumes worker execution

### queue.pause()
### queue.drain([callback]) // set concurrency to infinite and notify when idle again
pauses worker execution

### queue.drain([callback])
sets concurrency to infinite and notifies when idle

### queue.unshift([...args, callback]])
### queue.push([..args, callback])
unshifts task to queue

### queue.length()
### queue.shift()
### queue.pop()
### queue.push([..args, callback])
pushes task to queue

### queue.length
inherited from array, returns the queue length

### queue.shift()
inherited from array

### queue.pop()
inherited from array

0 comments on commit 5875860

Please sign in to comment.