Execute a function ambidextrously (normalizes the differences between synchronous and asynchronous functions). Useful for treating synchronous functions as asynchronous functions (like supporting both synchronous and asynchronous event definitions automatically).
- Install:
npm install --save ambi
- Module:
require('ambi')
- Install:
npm install --save ambi
- Module:
require('ambi')
- CDN URL:
//wzrd.in/bundle/[email protected]
- Install:
ender add ambi
- Module:
require('ambi')
This package is published with the following editions:
ambi
aliasesambi/index.js
which uses Editions to automatically select the correct edition for the consumers environmentambi/source/index.js
is esnext source code with require for modulesambi/edition-browsers/index.js
is esnext compiled for browsers with require for modulesambi/edition-node-0.8/index.js
is esnext compiled for node.js 0.8 with require for modules
// Import
const ambi = require('ambi')
let result = null
// Sample methods
function syncMethod (x, y) {
return x * y
}
function asyncMethod (x, y, next) {
return setTimeout(function () {
next(null, x * y)
}, 0)
}
// Call the synchronous function asynchronously
// ambi adds support for this asynchronous callback automatically
result = ambi(syncMethod, 5, 2, function (err, result) {
console.log(err, result) // null, 10
})
console.log(result) // 10 - just like normal
// Call the asynchronous function asynchronously
// ambi doesn't do anything special here
result = ambi(asyncMethod, 5, 2, function (err, result) {
console.log(err, result) // null, 10
})
console.log(result) // setTimeout - just like normal
- Ambi accepts the arguments
(method, ...args)
method
is the function to execute...args
is the arguments to send to the method- the last argument is expected to be the completion callback
- the completion callback is optional, but if defined, is expected to have the signature of
(err, ...results)
- If the method has equal or more arguments than ambi received, then we assume it is an asynchronous method and let it handle calling of the completion callback itself
- If the method has less arguments than ambi received, then we assume it is a synchronous method and we'll call the completion callback ourselves
- If the synchronous method throws an error or returns an error, we'll try to call the completion callback with a single
err
argument - If the synchronous method executes without error, we'll try to call the completion callback with a
err
argument equal to null, and aresult
argument equal to the returned result of the synchronous method
- If the synchronous method throws an error or returns an error, we'll try to call the completion callback with a single
Discover the release history by heading on over to the HISTORY.md
file.
Discover how you can contribute by heading on over to the CONTRIBUTING.md
file.
These amazing people are maintaining this project:
No sponsors yet! Will you be the first?
These amazing people have contributed code to this project:
Discover how you can contribute by heading on over to the CONTRIBUTING.md
file.
Unless stated otherwise all works are:
- Copyright © 2013+ Bevry Pty Ltd
- Copyright © 2011-2012 Benjamin Lupton
and licensed under: