a-callback
TypeScript icon, indicating that this package has built-in type declarations

0.1.1 • Public • Published

a-callback

A utility to convert node callbacks to promise

fromCallback

fromCallback(
    resolver: (cb: (error?: any, ...args: any[]) => any) => any,
    [Object {multiArgs: boolean=false} options]
) -> Promise
fromNode(
    resolver: (cb: (error?: any, ...args: any[]) => any) => any,
    [Object {multiArgs: boolean=false} options]
) -> Promise

Returns a promise that is resolved by a node style callback function. This is the most fitting way to do on the fly promisification when libraries don't expose classes for automatic promisification by undefined.

The resolver function is passed a callback that expects to be called back according to error-first node conventions.

Setting multiArgs to true means the resulting promise will always fulfill with an array of the callback's success value(s). This is needed because promises only support a single success value while some callback API's have multiple success value. The default is to ignore all but the first success value of a callback function.

Using manual resolver:

import util from 'util';
import {fromCallback} from 'a-callback';
// "email-templates" doesn't expose prototypes for promisification
const emailTemplates = util.promisify(require('email-templates'));
const templatesDir = path.join(__dirname, 'templates');

const template = await emailTemplates(templatesDir);
const [html, text] = await fromCallback(cb => template('newsletter', cb), {multiArgs: true});
console.log(html, text);

Package Sidebar

Install

npm i a-callback

Weekly Downloads

0

Version

0.1.1

License

MIT

Unpacked Size

7.3 kB

Total Files

7

Last publish

Collaborators

  • towyuan