"Fossies" - the Fresh Open Source Software Archive

Member "node-v12.18.4-win-x64/node_modules/npm/node_modules/pify/readme.md" (14 Feb 2020, 3334 Bytes) of package /windows/www/node-v12.18.4-win-x64.zip:

As a special service "Fossies" has tried to format the requested source page into HTML format (assuming markdown format). Alternatively you can here view or download the uninterpreted source code file. A member file download can also be achieved by clicking within a package contents listing on the according byte size field.

pify Build Status

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 => {
    //=> 'pify'

// Promisify all methods in a module
pify(fs).readFile('package.json', 'utf8').then(data => {
    //=> 'pify'


pify(input, options)

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. This also applies to rejections, where it returns an array of all the callback arguments, including the error.

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|Stream)$/]

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(null, data);

// Promisify methods but not `fn()`
const promiseFn = pify(fn, {excludeMain: true});

if (promiseFn()) {
    promiseFn.method('hi').then(data => {

Type: boolean
Default: true

Whether the callback has an error as the first argument. You’ll want to set this to false if you’re dealing with an API that doesn’t have an error as the first argument, like fs.exists(), some browser APIs, Chrome Extension APIs, etc.


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