summaryrefslogtreecommitdiff
path: root/alarm/node_modules/universalify/README.md
diff options
context:
space:
mode:
authorMinteck <contact@minteck.org>2023-01-10 14:54:04 +0100
committerMinteck <contact@minteck.org>2023-01-10 14:54:04 +0100
commit99c1d9af689e5325f3cf535c4007b3aeb8325229 (patch)
treee663b3c2ebdbd67c818ac0c5147f0ce1d2463cda /alarm/node_modules/universalify/README.md
parent9871b03912fc28ad38b4037ebf26a78aa937baba (diff)
downloadpluralconnect-99c1d9af689e5325f3cf535c4007b3aeb8325229.tar.gz
pluralconnect-99c1d9af689e5325f3cf535c4007b3aeb8325229.tar.bz2
pluralconnect-99c1d9af689e5325f3cf535c4007b3aeb8325229.zip
Update - This is an automated commit
Diffstat (limited to 'alarm/node_modules/universalify/README.md')
-rw-r--r--alarm/node_modules/universalify/README.md76
1 files changed, 0 insertions, 76 deletions
diff --git a/alarm/node_modules/universalify/README.md b/alarm/node_modules/universalify/README.md
deleted file mode 100644
index aa12474..0000000
--- a/alarm/node_modules/universalify/README.md
+++ /dev/null
@@ -1,76 +0,0 @@
-# universalify
-
-[![Travis branch](https://img.shields.io/travis/RyanZim/universalify/master.svg)](https://travis-ci.org/RyanZim/universalify)
-![Coveralls github branch](https://img.shields.io/coveralls/github/RyanZim/universalify/master.svg)
-![npm](https://img.shields.io/npm/dm/universalify.svg)
-![npm](https://img.shields.io/npm/l/universalify.svg)
-
-Make a callback- or promise-based function support both promises and callbacks.
-
-Uses the native promise implementation.
-
-## Installation
-
-```bash
-npm install universalify
-```
-
-## API
-
-### `universalify.fromCallback(fn)`
-
-Takes a callback-based function to universalify, and returns the universalified function.
-
-Function must take a callback as the last parameter that will be called with the signature `(error, result)`. `universalify` does not support calling the callback with three or more arguments, and does not ensure that the callback is only called once.
-
-```js
-function callbackFn (n, cb) {
- setTimeout(() => cb(null, n), 15)
-}
-
-const fn = universalify.fromCallback(callbackFn)
-
-// Works with Promises:
-fn('Hello World!')
-.then(result => console.log(result)) // -> Hello World!
-.catch(error => console.error(error))
-
-// Works with Callbacks:
-fn('Hi!', (error, result) => {
- if (error) return console.error(error)
- console.log(result)
- // -> Hi!
-})
-```
-
-### `universalify.fromPromise(fn)`
-
-Takes a promise-based function to universalify, and returns the universalified function.
-
-Function must return a valid JS promise. `universalify` does not ensure that a valid promise is returned.
-
-```js
-function promiseFn (n) {
- return new Promise(resolve => {
- setTimeout(() => resolve(n), 15)
- })
-}
-
-const fn = universalify.fromPromise(promiseFn)
-
-// Works with Promises:
-fn('Hello World!')
-.then(result => console.log(result)) // -> Hello World!
-.catch(error => console.error(error))
-
-// Works with Callbacks:
-fn('Hi!', (error, result) => {
- if (error) return console.error(error)
- console.log(result)
- // -> Hi!
-})
-```
-
-## License
-
-MIT