Giter Site home page Giter Site logo

promisify-es6's Introduction

NOTE: Starting from Node.js v.8.0.0, the promisify method is now included in the util native library.

On Node.js, the usage of the native method is recommended!

// Native promisify example
const util = require('util');
const readfile = util.promisify(fs.readFile);

ES6 Promisify

This is a library to promisify callback-style functions to ES6 promises. You can also use it on the client-side.

Install it with:

npm i --save promisify-es6
or
git clone https://github.com/manuel-di-iorio/promisify-es6.git

Example:

var promisify = require("promisify-es6");
var fs = require("fs");
var readFile = promisify(fs.readFile);

readFile("test.js")
 .then(function(content) {
    console.log(content.toString());
 })
 .catch(function(err) {
    console.error(err);
 });

A promisified function is still callable with the callback style:

readFile("test.js", function(err, content) { //etc...

You can even promisify entire modules or arrays:

var readFile = promisify(require("fs")).readFile;

API

promisify(method[, options])
*Method* can be a function or an array/map of functions to promisify

*Options* can have the following properties:

    `context`: The context which to apply the called function (by default is the function itself)
    `replace`: When an array/map is passed and this is truthy, it will replace the original object

Test with Mocha:

npm test

promisify-es6's People

Contributors

manuel-di-iorio avatar dignifiedquire avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.