Promisify a callback-style function
Last updated 9 months ago by sindresorhus .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install pify 
SYNC missed versions from official npm registry.

pify Build Status

Promisify a callback-style function

Get professional support for 'pify' with a Tidelift subscription
Tidelift helps make open source sustainable for maintainers while giving companies
assurances about security, maintenance, and licensing for their dependencies.


$ npm install 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.


  • p-event - Promisify an event by waiting for it to be emitted
  • p-map - Map over promises concurrently
  • More…


MIT © Sindre Sorhus

Current Tags

  • 4.0.1                                ...           latest (9 months ago)

10 Versions

  • 4.0.1                                ...           9 months ago
  • 4.0.0                                ...           a year ago
  • 3.0.0                                ...           2 years ago
  • 2.3.0                                ...           4 years ago
  • 2.2.0                                ...           4 years ago
  • 2.1.0                                ...           4 years ago
  • 2.0.0                                ...           4 years ago
  • 1.1.1                                ...           4 years ago
  • 1.1.0                                ...           4 years ago
  • 1.0.0                                ...           4 years ago
Maintainers (1)
Today 1,090
This Week 232,358
This Month 877,756
Last Day 57,787
Last Week 330,610
Last Month 1,184,804
Dependencies (0)
Dev Dependencies (4)
Dependents (1607)

Copyright 2014 - 2017 © taobao.org |