jeandesravines / promisify

:dizzy: Promisify Node's callback functions and modules

Promisify

/!\ Deprecated /!
Promisify Node.js's callback functions and modules

Table of contents

• Setup
• Usage
  • Import module
  • Promisify a module by name
  • Promisify a function
• API
• Example

Setup

This module can then be installed with yarn:

yarn add @jdes/promisify

Usage

Import module

/**
 * @type {Function}
 */
const promisify = require('@jdes/promisify');

Promisify a module by name

/**
* @type {Object}
*/
const fs = promisify('fs');

Promisify a function

/**
 * @type {Object}
 */
const fs = require('fs');

/**
 * @type {Object}
 */
const promisify = require('@jdes/promisify');

/**
 * @type {function}
 */
const readFile = promisify(fs.readFile);

API

promisify(data: Object | string | function): function(...[*]): Promise

Example

// Import the modue
const promisify = require('@jdes/promisify');

// Promisify by module name
const fs = promisify('fs');

// read file
fs.readFile('/dev/null')
  .then((data) => {
    console.log(data);
  })
  .catch((error) => {
    console.error(error);
  });