MZ - Modernize node.js

Modernize node.js to current ECMAScript specifications! node.js will not update their API to ES6+ for a while. This library is a wrapper for various aspects of node.js' API.

Installation and Usage

Set mz as a dependency and install it.

npm i mz

Then prefix the relevant require()s with mz/:

var fs = require('mz/fs')

fs.exists(__filename).then(function (exists) {
  if (exists) // do something
})

With ES2017, this will allow you to use async functions cleanly with node's core API:

const fs = require('mz/fs')


async function doSomething () {
  if (await fs.exists(__filename)) // do something
}

Promisification

Many node methods are converted into promises. Any properties that are deprecated or aren't asynchronous will simply be proxied. The modules wrapped are:

• child_process
• crypto
• dns
• fs (uses graceful-fs if available)
• readline
• zlib

var exec = require('mz/child_process').exec

exec('node --version').then(function (stdout) {
  console.log(stdout)
})

Promise Engine

mz uses any-promise.

FAQ

Can I use this in production?

Yes, Node 4.x ships with stable promises support. For older engines, you should probably install your own promise implementation and register it with require('any-promise/register')('bluebird').

Will this make my app faster?

Nope, probably slower actually.

Can I add more features?

Sure. Open an issue.

Currently, the plans are to eventually support:

• New APIs in node.js that are not available in older versions of node
• ECMAScript7 Streams

2.7.0 / 2017-09-13

• feat: support fs.copyFile (#58)

2.6.0 / 2016-11-22

• Added fdatasync to fs api (#46)

2.5.0 / 2016-11-04

• feat: support fs.mkdtemp

2.4.0 / 2016-03-23

• add fs.truncate() #34

2.3.1 / 2016-02-01

• update any-promise@v1

2.3.0 / 2016-01-30

• feat(package): switch to any-promise to support more promise engines

2.2.0 / 2016-01-24

• feat(package): add index.js to files

2.1.0 / 2015-10-15

• support for readline library

2.0.0 / 2015-05-24

• support callbacks as well

1.2.0 / 2014-12-16

• refactor promisification to thenify and thenify-all

1.1.0 / 2014-11-14

• use graceful-fs if available

1.0.1 / 2014-08-18

• don't use bluebird.promisify() - unnecessarily wraps runtime errors, causing issues

1.0.0 / 2014-06-18

• use bluebird by default if found
• support node 0.8