assured

assured

Combine promises and callbacks together.

:cloud: Installation

# Using npm
npm install --save assured

# Using yarn
yarn add 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") {
        cb(new Error("Invalid age."));
    } else {
        // 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);
});


// Async - Await
(async () => {
    const res = await foo(32)
    console.log(res);
})()

:question: Get Help

There are few ways to get help:

1. Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
2. For bug reports and feature requests, open issues. :bug:
3. For direct and quick help, you can use Codementor. :rocket:

: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.

:sparkling_heart: Support my projects

I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).

However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:

• Starring and sharing the projects you like :rocket:

• —I love books! I will remember you after years if you buy me one. :grin: :book:

• —You can make one-time donations via PayPal. I'll probably buy a coffee tea. :tea:

• —Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).

• Bitcoin—You can send me bitcoins at this address (or scanning the code below): 1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6

  

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:

• scrape-it
• tinyreq
• fn-result
• fs-file-tree
• bloggify-plugin-loader
• bloggify-plugin-class
• scrape-it-plus
• @slikts/scrape-it
• csv-it

:scroll: License

MIT © Ionică Bizău