Simple promisify a callback-style function with sane defaults. Support promisify-ing sync functions.
What's the difference?
What's the difference between me and you?!
–– Dr Dre feat. Eminem & X-Zibit - Whats the Difference, https://youtu.be/8y5MjguI-pM
What's the difference between this module, relike-all and redolent?
–– Simply, almost nothing.
- This one just accept
sync
or async
function which is executed immediately with next arguments, after that it returns Promise
. - relike-all accepts everything and returns
Promise
. But it is little bit tricky:
- if you pass only one non-function argument to it, it will pass it to promise
- if you pass more that one arguments to it, it will create array from them and pass it to promise
- if you pass
function
as first argument, next arguments will be passed to this function
- redolent accepts everything and returns function, which when is executed it returns
Promise
. Above things applies here, because it is on top of relike-all
.
Notice: Both relike
and relike-all
direcly executes first argument (if function) and returns Promise
.
Install
npm i relike --save
Usage
For more use-cases see the tests
const relike = require('relike')
Will try to promisify fn
with native Promise, otherwise will use Bluebird
or you can give different promise module to relike.promise
, for example pinkie
.
<fn>
{Function} callback-style or synchronous function to promisifyreturn
{Promise} promise
Example
const fs = require('fs')
const request = require('request')
const relike = require('relike')
relike(fs.readFile, 'package.json', 'utf-8').then(data => {
console.log(JSON.parse(data).name)
})
relike(fs.readFileSync, 'package.json', 'utf-8')
.then(JSON.parse)
.then(res => {
console.log(res.name)
})
relike(request, 'http://www.tunnckocore.tk/').then(result => {
const [httpResponse, body] = result
})
relike.promise
Static property on which you can pass custom Promise module to use, e.g. Q
constructor.
Example
const fs = require('fs')
const relike = require('relike')
relike.promise = require('q')
relike(fs.readFile, 'package.json', 'utf-8').then(data => {
console.log(JSON.parse(data).name)
})
Access Promise constructor
You can access the used Promise constructor for promisify-ing from promise.Prome
Example
const fs = require('fs')
const relike = require('relike')
relike.promise = require('pinkie')
const promise = relike(fs.readFile, 'package.json', 'utf8')
console.log(promise.Prome)
console.log(promise.Prome.___customPromise)
console.log(promise.___customPromise)
promise
.then(JSON.parse)
.then(data => {
console.log(data.name)
})
Related
- always-done: Handles completion and errors of anything!
- always-promise: Promisify, basically, everything. Generator function, callback-style or synchronous function; sync function that returns child process, stream or observable; directly passed promise, stream or child process.
- always-thunk: Thunkify, basically, everything. Generator function, callback-style or synchronous function; sync function that returns child process, stream or observable; directly passed promise, stream or child process.
- always-generator: Generatorify, basically, everything. Async, callback-style or synchronous function; sync function that returns child process, stream or observable; directly passed promise, stream or child process.
- native-or-another: Always will expose native
Promise
if available, otherwise Bluebird
but only if you don't give another promise module like q
or promise
or what you want. - native-promise: Get native
Promise
or falsey value if not available.
Contributing
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
But before doing anything, please read the CONTRIBUTING.md guidelines.