Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mjlescano/fail-safe-queue
Node.js callbacks queue with rollback capabilities on fail.
https://github.com/mjlescano/fail-safe-queue
Last synced: 22 days ago
JSON representation
Node.js callbacks queue with rollback capabilities on fail.
- Host: GitHub
- URL: https://github.com/mjlescano/fail-safe-queue
- Owner: mjlescano
- Created: 2015-02-27T04:30:32.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-01-25T14:41:11.000Z (almost 8 years ago)
- Last Synced: 2024-08-08T17:42:05.177Z (3 months ago)
- Language: JavaScript
- Size: 3.91 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Disclaimer
**Don't use this LIB! [This](https://github.com/mjlescano/batch) one does the same with a much better interface.**
# Fail Safe Queue
It's a very simple Queue of functions. But also let's you define, for each one, a
rollback in case something goes wrong later on the queue stack calling.
Heavily inspired by [caolan/async](https://github.com/caolan/async).
## Installation
`npm install fail-safe-queue --save`
## Quick Examples
__Success example:__
```js
var queue = require('fail-safe-queue')
queue([
{
up: function(next){
console.log('+ up! 1')
next(null, 1)
},
down: function(prev){
console.log('- down! 1')
prev()
}
},
function(next){
console.log('+ up! 2')
next(null, 2)
},
{
up: function(next){
console.log('+ up! 3')
next('3 con error', 3)
},
down: function(prev){
console.log('- down! 3')
prev()
}
}
], function(err, upResults, downResults){
console.log('err', err)
console.log('upResults', upResults)
})
```
__Will echo:__
```
+ up! 1
+ up! 2
+ up! 3
err null
results [ [ 1 ], [ 2 ], [ 3 ] ]
```
__Fail example:__
```js
var queue = require('fail-safe-queue')
queue([
{
up: function(next){
console.log('+ up! 1')
next(null, 1)
},
down: function(prev){
console.log('- down! 1')
prev()
}
},
{
up: function(next){
console.log('+ up! 2')
next('This method triggered an error :S', 2)
},
down: function(prev){
console.log('- down! 2')
prev()
}
},
{
up: function(next){
console.log('+ up! 3')
next(null, 3)
},
down: function(prev){
console.log('- down! 3')
prev()
}
}
], function(err, upResults){
console.log('err', err)
console.log('upResults', upResults)
})
```
__Will echo:__
```
+ up! 1
+ up! 2
- down! 1
err This method triggered an error :S
results [ [ 1 ] ]
```
## API
### queue(tasks, [callback])
__Arguments__
* `tasks` - It's an array of tasks. Each task could be a simple function to be
called in order or an object with two functions, `up: [Function(next)]` and
`down: [Function(prev)]`.
* `callback(err, results)` - An optional callback to run once all the functions
have completed. This function gets a results array containing all the result
arguments passed to the `task` callbacks.