Handles completion and errors for callbacks, promises, observables and streams.
Will run call the function on nextTick
. This will cause all functions to be async.
var asyncDone = require('async-done');
asyncDone(function(done){
// do async things
done(null, 2);
}, function(error, result){
// `error` will be undefined on successful execution of the first function.
// `result` will be the result from the first function.
});
var asyncDone = require('async-done');
asyncDone(function(done){
// do async things
done(new Error('Some Error Occurred'));
}, function(error, result){
// `error` will be an error from the first function.
// `result` will be undefined on failed execution of the first function.
});
Takes a function to execute (fn
) and a function to call on completion (callback
).
Optionally takes a callback to call when async tasks are complete.
Callback
called- Completion: called with null error
- Error: called with non-null error
Stream
orEventEmitter
returned- Completion: end-of-stream module
- Error: domains
Promise
returned- Completion: onFulfilled method called
- Error: onRejected method called
Observable
returned- Completion: onCompleted method called
- Error: onError method called
Warning: Sync taks are not supported and your function will never complete if the one of the above strategies is not used to signal completion. However, thrown errors will be caught by the domain.
If an error doesn't occur in the execution of the fn
function, the callback
method will receive the results as its second argument. Note: Observable and some streams don't received any results.
If an error occurred in the execution of the fn
function, The callback
method will receive an error as its first argument.
Errors can be caused by:
- A thrown error
- An error passed to a
done
callback - An
error
event emitted on a returnedStream
orEventEmitter
- A rejection of a returned
Promise
- The
onError
handler being called on anObservable
MIT