dualAPI
Make your module implement dual APIs.
When the method of your module is called, if a callback Function is appended to the arguments, the method works as callback API. Otherwise the method returns a thenable Promise
instance.
For example:
This egg
module exports two methods.
The egg.fry
method returns 'fried egg'
if it is called with 'oil'
, otherwise it returns [Error: burnt egg]
. The egg.boil
method returns 'boiled egg'
if it is called with 'water'
, otherwise it returns [Error: broken egg]
. These are the same as a function that is passed to Promise
constructor.
After setting up exports
, call require('dual-api')
.
// `egg` module { console; ;} { console; ;} exportsfry = fry;exportsboil = boil; ;
A code that uses egg
module:
const egg = ; // Call methods as callback API: egg; egg; // Call methods as thenable API: egg ; egg ;
Results:
An egg is fried with oil.
Got a fried egg.
An egg is boiled with water.
Got a boiled egg.
An egg is fried with oil.
Got a fried egg.
An egg is boiled with water.
Got a boiled egg.
A single method that is set to module.exports
is also supported.
For example, egg-fly
module that exports only fry
method:
// `egg-fly` module // There is `fry` function. moduleexports = fry;;
A code that uses egg-fly
module:
const eggFly = ; // Call method as callback API: ; // Call method as thenable API: ;
By default, all exported methods implement dual APIs.
You can specify methods that implement dual APIs by using exports._dualApi_methodNames
array.
For example, the module exports fry
, boil
and beatUp
methods, and only boil
and beatUp
methods implement dual APIs.
// `egg` module // There are `fry`, `boil` and `beatUp` functions. exportsfry = fry;exportsboil = boil;exportsbeatUp = beatUp; exports_dualApi_methodNames = 'boil' `beatUp`; ;