- Big update!Announcing Socket for GitHub 1.0. Learn more →
universalify
Advanced tools
universalify
Make a callback- or promise-based function support both promises and callbacks.
- 2.0.0latest
- Version published
- Maintainers
- 1
- Weekly downloads
- 45,385,874
- decreased by-3.36%
Weekly downloads
Changelog
v2.0.0
- Properly handle falsy errors (#13). This is technically a BREAKING CHANGE, but will not affect the vast majority of users.
- Performance improvements for
fromCallback(#12).
Thanks to @joepie91 for submitting the fixes for this release!
Readme
universalify
Make a callback- or promise-based function support both promises and callbacks.
Uses the native promise implementation.
Installation
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.
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.
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
FAQs
What is universalify?
Make a callback- or promise-based function support both promises and callbacks.
Is universalify popular?
The npm package universalify receives a total of 36,332,986 weekly downloads. As such, universalify popularity was classified as popular.
Is universalify well maintained?
We found that universalify demonstrated a not healthy version release cadence and project activity. It has 1 open source maintainer collaborating on the project.