tra-analysis/website/functions/node_modules/call-me-maybe/README.md

27 lines
821 B
Markdown
Raw Normal View History

2019-01-06 19:14:45 +00:00
# call-me-maybe [![Build Status](https://travis-ci.org/limulus/call-me-maybe.svg?branch=master)](https://travis-ci.org/limulus/call-me-maybe)
Let your JS API users either give you a callback or receive a promise.
## Usage
```javascript
var maybe = require("call-me-maybe")
module.exports = function asyncFunc (cb) {
return maybe(cb, new Promise(function(resolve, reject) {
// ...
}))
}
```
## API
### maybe(cb, promise)
If the callback `cb` is truthy, returns `undefined` and will call `cb` when `promise` is settled. The parameters passed to `cb` are standard error-first:
- If `promise` is fulfilled, then it is called with the result of the promise: `cb(null, result)`
- If `promise` is rejected, then it is called with the rejection error: `cb(err)`
If `cb` is falsey, then `promise` is retuned.