node-callbackmaybe
A module that makes it easy to support both event emitters and callbacks in your node.js API methods.
Usage
var CallbackMaybe = ; YourModuleprototype var cbm = callback options; ; returncbm; ;
In the above example, if someMethod
is passed a callback, the callback will be invoked with an array of the items written via cbm.write()
. The callback will be invoked with an error if cbm.error()
is called.
With or without a callback, an EventEmitter is returned which will emit a data
event for each item written and an end
event with a count of items emitted. An error
event is emitted if cbm.error()
is called.
A method implemented as above will support the following access methods:
yourModule; yourModule; yourModule;
You can present the same interface options even if you only have access to an array internally:
YourModuleprototype var cbm = callback options; ; returncbm; ;
anotherMethod
will have the same access methods as someMethod
above.
Currently only one option
is supported:
- limit - the maximum number of items to emit or pass to the callback. Calls to
write
after the limit is reached will returnfalse
.
Install
npm install callbackmaybe
Dependencies
This library has no production dependencies, only the following test dependencies: