call-me-maybe

What is call-me-maybe?

The 'call-me-maybe' npm package is designed to handle callbacks and promises in a unified way. It allows developers to write functions that can return a promise if no callback is provided, or execute a callback if one is given. This flexibility makes it easier to work with asynchronous code in JavaScript.

What are call-me-maybe's main functionalities?

Handling callbacks and promises

This feature allows a function to handle both callbacks and promises. If a callback is provided, it is called with the result; otherwise, a promise is returned. The code sample demonstrates how to implement a simple asynchronous operation that can be used either way.

const maybe = require('call-me-maybe');

function asyncOperation(callback) {
  return maybe(callback, new Promise((resolve, reject) => {
    setTimeout(() => resolve('Done!'), 1000);
  }));
}

// Using with callback
asyncOperation(result => console.log(result));

// Using as a promise
asyncOperation().then(result => console.log(result));

Other packages similar to call-me-maybe

bluebird

Bluebird is a comprehensive promise library that provides a rich set of features for working with promises. It includes utilities for converting callback-based APIs to promises, which is similar to what 'call-me-maybe' offers, but it is more feature-rich and includes optimizations for performance.

pify

Pify is a module that converts callback-based functions or modules to return promises. It is similar to 'call-me-maybe' in that it helps bridge the gap between callbacks and promises, but it focuses solely on converting existing functions rather than handling both styles in new functions.

README

call-me-maybe

Let your JS API users either give you a callback or receive a promise.

Usage

var maybe = require("call-me-maybe")

module.exports = function asyncFunc (cb) {
  return maybe(cb, new Promise(function(resolve, reject) {
    // ...
  }))
}

API

maybe(cb, promise)

If the callback cb is truthy, returns undefined and will call cb when promise is settled. The parameters passed to cb are standard error-first:

• If promise is fulfilled, then it is called with the result of the promise: cb(null, result)
• If promise is rejected, then it is called with the rejection error: cb(err)

If cb is falsey, then promise is returned.