rfpify alternatives and similar modules
Based on the "Promises" category.
Alternatively, view rfpify alternatives based on common mentions on social networks and blogs.
CodeRabbit: AI Code Reviews for Developers
* Code Quality Rankings and insights are calculated and provided by Lumnify.
They vary from L1 to L5 with "L5" being the highest.
Do you think we are missing an alternative of rfpify or a related project?
Popular Comparisons
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
*Note that all licence references and agreements mentioned in the rfpify README section above
are relevant to that project's source code only.