Promisify a callback-style function
$ npm install --save pify
const fs = require('fs');
const pify = require('pify');
// promisify a single function
pify(fs.readFile)('package.json', 'utf8').then(data => {
console.log(JSON.parse(data).name);
//=> 'pify'
});
// or promisify all methods in a module
pify(fs).readFile('package.json', 'utf8').then(data => {
console.log(JSON.parse(data).name);
//=> 'pify'
});Returns a Promise wrapped version of the supplied function or module.
Type: Function Object
Callback-style function or module whose methods you want to promisify.
Type: boolean
Default: false
By default, the promisified function will only return the second argument from the callback, which works fine for most APIs. This option can be useful for modules like request that return multiple arguments. Turning this on will make it return an array of all arguments from the callback, excluding the error argument, instead of just the second argument.
const request = require('request');
const pify = require('pify');
pify(request, {multiArgs: true})('https://sindresorhus.com').then(result => {
const [httpResponse, body] = result;
});Type: string[] RegExp[]
Methods in a module to promisify. Remaining methods will be left untouched.
Type: string[] RegExp[]
Default: [/.+Sync$/]
Methods in a module not to promisify. Methods with names ending with 'Sync' are excluded by default.
Type: boolean
Default: false
If given module is a function itself, it will be promisified. Turn this option on if you want to promisify only methods of the module.
const pify = require('pify');
function fn() {
return true;
}
fn.method = (data, callback) => {
setImmediate(() => {
callback(data, null);
});
};
// promisify methods but not fn()
const promiseFn = pify(fn, {excludeMain: true});
if (promiseFn()) {
promiseFn.method('hi').then(data => {
console.log(data);
});
}Type: Function
Custom promise module to use instead of the native one.
Check out pinkie-promise if you need a tiny promise polyfill.
MIT © Sindre Sorhus