summaryrefslogtreecommitdiff
path: root/node_modules/universalify/README.md
diff options
context:
space:
mode:
authorlittleblack111 <littleblack11111@gmail.com>2026-05-18 23:10:59 +0800
committerlittleblack111 <littleblack11111@gmail.com>2026-05-18 23:41:44 +0800
commitfc87c009806dcc98867f6b58efe29b042aa01dee (patch)
tree8f59b3f4a5b66e9dfef2d40c8d318e258a521228 /node_modules/universalify/README.md
parent3336b2356ee6152d9c6ae59bd9b87ccbc0958407 (diff)
node: updatemain
Diffstat (limited to 'node_modules/universalify/README.md')
-rw-r--r--node_modules/universalify/README.md76
1 files changed, 0 insertions, 76 deletions
diff --git a/node_modules/universalify/README.md b/node_modules/universalify/README.md
deleted file mode 100644
index 1184939d..00000000
--- a/node_modules/universalify/README.md
+++ /dev/null
@@ -1,76 +0,0 @@
-# universalify
-
-![GitHub Workflow Status (branch)](https://img.shields.io/github/actions/workflow/status/RyanZim/universalify/ci.yml?branch=master)
-![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