Socket
Socket
Sign inDemoInstall

promisify-es6

Package Overview
Dependencies
Maintainers
1
Versions
3
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

promisify-es6

Promisify callback-style functions to ES6 promises


Version published
Weekly downloads
9.5K
decreased by-17.33%
Maintainers
1
Weekly downloads
 
Created
Source

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

Keywords

FAQs

Package last updated on 26 Jul 2017

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc