https://github.com/ljharb/util.promisify
Polyfill/shim for util.promisify in node versions < v8
https://github.com/ljharb/util.promisify
Last synced: 6 months ago
JSON representation
Polyfill/shim for util.promisify in node versions < v8
- Host: GitHub
- URL: https://github.com/ljharb/util.promisify
- Owner: ljharb
- License: mit
- Created: 2017-05-30T20:03:29.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2024-12-18T17:49:41.000Z (10 months ago)
- Last Synced: 2025-03-10T00:23:58.686Z (7 months ago)
- Language: JavaScript
- Homepage:
- Size: 110 KB
- Stars: 127
- Watchers: 4
- Forks: 15
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# util.promisify
Polyfill for util.promisify in node versions < v8
node v8.0.0 added support for a built-in `util.promisify`: https://github.com/nodejs/node/pull/12442/
This package provides the built-in `util.promisify` in node v8.0.0 and later, and a replacement in other environments.
## Usage
**Direct**
```js
const promisify = require('util.promisify');
// Use `promisify` just like the built-in method on `util`
```
**Shim**
```js
require('util.promisify/shim')();
// `util.promisify` is now defined
const util = require('util');
// Use `util.promisify`
```
Note: this package requires a native ES5 environment, and for `Promise` to be globally available. It will throw upon requiring it if these are not present.
## Promisifying modules
If you want to promisify a whole module, like the `fs` module, you can use [`util.promisify-all`](https://www.npmjs.com/package/util.promisify-all).