bahmutov / vo-task

Wraps data.task around VO async function
4 stars 0 forks source link

vo-task

Wraps data.task around VO async function

NPM

Build status semantic-release

Install and use

npm install --save vo-task
const voTask = require('vo-task')

Use

Suppose you have a plain function, like add(a, b) { return a + b }. You can convert this function into a Task-returning function

function add(a, b) { return a + b }
const makeTask = voTask(add)
const addTask = makeTask(2, 3)
// nothing has been executed so far

Or you have a promise-returning function that you want to convert into a Task-returning function

function addAsync(a, b) {
  return Promise.resolve(a + b)
}
const makeTask = voTask(addAsync)
const addTask = makeTask(2, 3)
// nothing has been executed so far

Or any other asynchronous function (like generators, callbacks, etc - see vo docs for all supported types). Then you can combine the tasks into longer tasks before executing anything. The original function only runs when you call task.fork(onError, onSuccess) method.

addTask.fork(console.error, function (result) {
  console.log('add result', result)
})

vo-task makes longer chains across multiple async styles easy.

Related projects

Small print

Author: Gleb Bahmutov © 2016

License: MIT - do anything with the code, but don't blame me if it does not work.

Spread the word: tweet, star on github, etc.

Support: if you find any problems with this module, email / tweet / open issue on Github

MIT License

Copyright (c) 2016 Gleb Bahmutov

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.