Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sindresorhus/pify

Promisify a callback-style function
https://github.com/sindresorhus/pify

promise-utilities promises promisify

Last synced: 2 days ago
JSON representation

Promisify a callback-style function

Awesome Lists containing this project

README 

        
# pify



> Promisify a callback-style function



## Install



```sh

npm install pify

```



## Usage



```js

import fs from 'fs';

import pify from 'pify';



// Promisify a single function.

const data = await pify(fs.readFile)('package.json', 'utf8');

console.log(JSON.parse(data).name);

//=> 'pify'



// Promisify all methods in a module.

const data2 = await pify(fs).readFile('package.json', 'utf8');

console.log(JSON.parse(data2).name);

//=> 'pify'

```



## API



### pify(input, options?)



Returns a `Promise` wrapped version of the supplied function or module.



#### input



Type: `Function | object`



Callback-style function or module whose methods you want to promisify.



#### options



Type: `object`



##### multiArgs



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.



```js

import request from 'request';

import pify from 'pify';



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



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

```



##### include



Type: `Array`



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



##### exclude



Type: `Array`\

Default: `[/.+(?:Sync|Stream)$/]`



Methods in a module **not** to promisify. Methods with names ending with `'Sync'` are excluded by default.



##### excludeMain



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.



```js

import pify from '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()) {

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

}

```



##### errorFirst



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.



##### promiseModule



Type: `Function`



Custom promise module to use instead of the native one.



## FAQ



#### How is this different from Node.js's [`util.promisify`](https://nodejs.org/api/util.html#util_util_promisify_original)?



- Pify existed long before `util.promisify`.

- Pify is [faster](https://github.com/sindresorhus/pify/issues/41#issuecomment-429988506).

- 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](https://nodejs.org/api/util.html#util_custom_promisified_functions) for certain Node.js methods and instead focuses on predictability.



#### How can I promisify a single class method?



Class methods are not bound, so when they're not called on the class itself, they don't have any context. You can either promisify the whole class or use `.bind()`.



```js

import pify from 'pify';

import SomeClass from './some-class.js';



const someInstance = new SomeClass();



// ❌ `someFunction` can't access its class context.

const someFunction = pify(someClass.someFunction);



// ✅ The whole class is promisified and the `someFunction` method is called on its class.

const someClassPromisified = pify(someClass);

someClassPromisified.someFunction();



// ✅ `someFunction` is bound to its class before being promisified.

const someFunction = pify(someClass.someFunction.bind(someClass));

```



#### Why is `pify` choosing the last function overload when using it with TypeScript?



If you're using TypeScript and your input has [function overloads](https://www.typescriptlang.org/docs/handbook/2/functions.html#function-overloads), then only the last overload will be chosen and promisified. [This is a TypeScript limitation.](https://github.com/microsoft/TypeScript/issues/32164)



If you need to choose a different overload, consider using a type assertion:



```ts

function overloadedFunction(input: number, callback: (error: unknown, data: number) => void): void

function overloadedFunction(input: string, callback: (error: unknown, data: string) => void): void {

	/* … */

}



const fn = pify(overloadedFunction as (input: number, callback: (error: unknown, data: number) => void) => void)

//    ^? (input: number) => Promise

```



## Related



- [p-event](https://github.com/sindresorhus/p-event) - Promisify an event by waiting for it to be emitted

- [p-map](https://github.com/sindresorhus/p-map) - Map over promises concurrently

- [More…](https://github.com/sindresorhus/promise-fun)