Files
common/docs/util/modules/_promisify_.md
T
2018-10-22 18:34:54 +00:00

1.1 KiB

Functions

promisify

▸ promisify(self: any, fn: Function, ...params: Array<any>): Promise<any>

Defined in promisify.ts:21

name: promisify

signature: function promisify (this: ?Object, fn: Function, ...params: Array): Promise

summary: Wraps an async callback into a Promise

description: Wraps the supplied async function fn that has a standard JS callback (error: Error, result: any) into a Promise, passing the supplied parameters. When error is set, the Promise is rejected, else the Promise resolves with the result value.

example:

const { promisify } from '@polkadot/util';

await promisify(null, ((a, cb) => cb(null, a), true); // resolves with `true`
await promisify(null, (cb) => cb(new Error('error!'))); // rejects with `error!`

Parameters:

Param Type
self any
fn Function
Rest params Array<any>

Returns: Promise<any>