rfpify

[DEPRECATED] Promisify a result-first callback function.

Code Quality Rank: L5

Monthly Downloads: 0

Programming language: JavaScript

License: MIT License

Tags: Control Flow     Promises     Async     Promise     Callback     Then     Promisify    

Latest version: v1.0.1

README

rfpify

Promisify a result-first callback-style function.

---

Deprecated in favour of pify with the errorFirst option.

---

Install

$ npm install --save rfpify

Usage

const rfpify = require('rfpify');

rfpify(stream.once.bind(stream))('data').then(data => {
    // handle data
});

API

rfpify(input, [promiseModule], [options])

Returns a promise wrapped version of the supplied function or module.

input

Type: function, object

Result-first callback-style function.

promiseModule

Type: function

Custom promise module to use instead of the native one.

Check out pinkie-promise if you need a tiny promise polyfill.

options

multiArgs

Type: boolean Default: false

By default, the promisified function will only return the first argument from the callback, which works fine for most APIs. Turning this on will make it return an array of all arguments from the callback, instead of just the first argument.

include

Type: array of (string|regex)

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

exclude

Type: array Default: [/.+Sync$/]

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

excludeMain

Type: boolean Default: false

By default, if given module is a function itself, this function will be promisified. Turn this option on if you want to promisify only methods of the module.

const rfpify = require('rfpify');

function fn() {
    return true;
}

fn.method = (data, callback) => {
    setImmediate(() => {
        callback(data);
    });
};

// promisify methods but not fn()
const promiseFn = rfpify.all(fn, {excludeMain: true});

if (promiseFn()) {
    promiseFn.method('hi').then(data => {
        console.log(data);
    });
}

Related

• pify - Promisify a callback-style function

License

MIT © Sam Verschueren