assured

assured

Combine promises and callbacks together.

:cloud: Installation

$ npm i --save assured

:clipboard: Example

const assured = require("assured");

let foo = (age, cb) => {

    // Swap the callback function
    if (typeof age === "function") {
        cb = age;
    }

    // Proxy the callback function
    cb = assured(cb);

    // Validate the age
    if (typeof age !== "number") {
        return cb(new Error("Invalid age."));
    }

    // Do something async
    setTimeout(() => {
        cb(null, `The provided age is ${age}`);
    }, 100);

    // Return the promise
    return cb._;
}

// Callback interface + error
foo(err => console.log(err));
// => [Error: Invalid age.]

// Callback interface + success
foo(42, (err, data) => console.log(err, data));
// => null 'The provided age is 42'

// Promise interface + error
foo().then(x => {
    console.log("Success: ", x);
}).catch(e => {
    console.log("Error: ", e);
    // => Error:  [Error: Invalid age.]
});

// Promise + Success
foo(42).then(x => {
    console.log("Success: ", x);
}).catch(e => {
    console.log("Error: ", e);
});

:memo: Documentation

assured(fn, p)

Proxies the callback function.

Params

• Function fn: The callback function to proxy.
• Promise p: A custom promise constructor (default: the built-in Promise).

Return

• Function The proxied callback function extended with:
• resolver (Function): The promise resolver.
• assuredResolve (Function): The resolve method.
• assuredReject (Function): The reject method.
• _ (Promise): The promise object (used to return from your function).

:yum: How to contribute

Have an idea? Found a bug? See how to contribute.

:moneybag: Donations

Another way to support the development of my open-source modules is to set up a recurring donation, via Patreon. :rocket:

PayPal donations are appreciated too! Each dollar helps.

Thanks! :heart:

:dizzy: Where is this library used?

If you are using this library in one of your projects, add it in this list. :sparkles:

• fn-result—Take an (a)sync function result and pass it forward.
• scrape-it—A Node.js scraper for humans.

:scroll: License

MIT © Ionică Bizău