Promisify a callback-style function
Last updated 5 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


$ npm install pify


const fs = require('fs');
const pify = require('pify');

(async () => {
	// Promisify a single function.
	const data = await pify(fs.readFile)('package.json', 'utf8');
	//=> 'pify'

	// Promisify all methods in a module.
	const data2 = await pify(fs).readFile('package.json', 'utf8');
	//=> '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: object


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');

const pRequest = pify(request, {multiArgs: true});

(async () => {
	const [httpResponse, body] = await pRequest('https://sindresorhus.com');

Type: Array<string | RegExp>

Methods in a module to promisify. Remaining methods will be left untouched.


Type: Array<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 the given module is a function itself, it will be promisified. Enable this option 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);

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

	if (promiseFn()) {
		console.log(await promiseFn.method('hi'));

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.


How is this different from Node.js's util.promisify?

  • Pify existed long before util.promisify.
  • Pify is faster.
  • Pify supports wrapping a whole module/object, not just a specific method.
  • Pify has useful options like the ability to handle multiple arguments (multiArgs).
  • Pify does not have magic behavior for certain Node.js methods and instead focuses on predictability.


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

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.

Current Tags

  • 5.0.0                                ...           latest (5 months ago)

11 Versions

  • 5.0.0                                ...           5 months ago
  • 4.0.1                                ...           2 years ago
  • 4.0.0                                ...           2 years ago
  • 3.0.0                                ...           3 years ago
  • 2.3.0                                ...           5 years ago
  • 2.2.0                                ...           5 years ago
  • 2.1.0                                ...           5 years ago
  • 2.0.0                                ...           5 years ago
  • 1.1.1                                ...           5 years ago
  • 1.1.0                                ...           5 years ago
  • 1.0.0                                ...           5 years ago
Maintainers (1)
Today 55,539
This Week 350,338
This Month 151,920
Last Day 96,381
Last Week 464,187
Last Month 2,321,577
Dependencies (0)
Dev Dependencies (4)
Dependents (1781)

Copyright 2014 - 2016 © taobao.org |