deps/npm/node_modules/util-promisify/README.md


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42


# util-promisify

Node 8's [`require('util').promisify`](https://nodejs.org/api/util.html#util_util_promisify_original) as a node module, so you can use it right now!

Supports [all major node versions](https://github.com/nodejs/LTS#lts-schedule1).

[![build status](https://travis-ci.org/juliangruber/util-promisify.svg?branch=master)](http://travis-ci.org/juliangruber/util-promisify)
[![downloads](https://img.shields.io/npm/dm/util-promisify.svg)](https://www.npmjs.org/package/util-promisify)
[![Greenkeeper badge](https://badges.greenkeeper.io/juliangruber/util-promisify.svg)](https://greenkeeper.io/)

## Usage

```js
const promisify = require('util-promisify');
const fs = require('fs');

const stat = promisify(fs.stat);

stat('/tmp/').then(s => {
  // ...
});
```

## Installation

```bash
$ npm install util-promisify
```

## API

See `util.promisify`'s [API docs](https://nodejs.org/api/util.html#util_util_promisify_original).

### promisify(original)
### (Symbol) promisify.custom

If available, the Symbol is reexported from node core's `util` module.

## License

MIT