aboutsummaryrefslogtreecommitdiff
path: root/node_modules/call-me-maybe/README.md
diff options
context:
space:
mode:
authorDimitri Staessens <dimitri@ouroboros.rocks>2019-10-06 21:37:45 +0200
committerDimitri Staessens <dimitri@ouroboros.rocks>2019-10-06 21:37:45 +0200
commit3c51c3be85bb0d1bdb87ea0d6632f1c256912f27 (patch)
treec7ccc8279b12c4f7bdbbb4270d617e48f51722e4 /node_modules/call-me-maybe/README.md
parent412c104bebc507bea9c94fd53b5bdc4b64cbfe31 (diff)
downloadwebsite-3c51c3be85bb0d1bdb87ea0d6632f1c256912f27.tar.gz
website-3c51c3be85bb0d1bdb87ea0d6632f1c256912f27.zip
build: Add some required modules for node
Diffstat (limited to 'node_modules/call-me-maybe/README.md')
-rw-r--r--node_modules/call-me-maybe/README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/node_modules/call-me-maybe/README.md b/node_modules/call-me-maybe/README.md
new file mode 100644
index 0000000..ac74451
--- /dev/null
+++ b/node_modules/call-me-maybe/README.md
@@ -0,0 +1,26 @@
+# 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.