|
1 |
| -# util |
| 1 | +# util [](https://travis-ci.org/defunctzombie/node-util) |
2 | 2 |
|
3 |
| -[](https://travis-ci.org/defunctzombie/node-util) |
| 3 | +> Node.js's [util][util] module for all engines. |
4 | 4 |
|
5 |
| -node.js [util](http://nodejs.org/api/util.html) module as a module |
| 5 | +This implements the Node.js [`util`][util] module for environments that do not have it, like browsers. |
6 | 6 |
|
7 |
| -## install via [npm](npmjs.org) |
| 7 | +## Install |
| 8 | + |
| 9 | +You usually do not have to install `util` yourself. If your code runs in Node.js, `util` is built in. If your code runs in the browser, bundlers like [browserify](https://github.com/browserify/browserify) or [webpack](https://github.com/webpack/webpack) also include the `util` module. |
| 10 | + |
| 11 | +But if none of those apply, with npm do: |
8 | 12 |
|
9 | 13 | ```shell
|
10 | 14 | npm install util
|
11 | 15 | ```
|
12 | 16 |
|
13 |
| -## browser support |
| 17 | +## Usage |
| 18 | + |
| 19 | +```javascript |
| 20 | +var util = require('util') |
| 21 | +var EventEmitter = require('events') |
| 22 | + |
| 23 | +function MyClass() { EventEmitter.call(this) } |
| 24 | +util.inherits(MyClass, EventEmitter) |
| 25 | +``` |
| 26 | + |
| 27 | +## Browser Support |
| 28 | + |
| 29 | +The `util` module uses ES5 features. If you need to support very old browsers like IE8, use a shim like [`es5-shim`](https://www.npmjs.com/package/es5-shim). You need both the shim and the sham versions of `es5-shim`. |
| 30 | + |
| 31 | +To use `util.promisify` and `util.callbackify`, Promises must already be available. If you need to support browsers like IE11 that do not support Promises, use a shim. [es6-promise](https://github.com/stefanpenner/es6-promise) is a popular one but there are many others available on npm. |
| 32 | + |
| 33 | +## API |
| 34 | + |
| 35 | +See the [Node.js util docs][util]. `util` currently supports the Node 8 LTS API. However, some of the methods are outdated. The `inspect` and `format` methods included in this module are a lot more simple and barebones than the ones in Node.js. |
| 36 | + |
| 37 | +## Contributing |
| 38 | + |
| 39 | +PRs are very welcome! The main way to contribute to `util` is by porting features, bugfixes and tests from Node.js. Ideally, code contributions to this module are copy-pasted from Node.js and transpiled to ES5, rather than reimplemented from scratch. Matching the Node.js code as closely as possible makes maintenance simpler when new changes land in Node.js. |
| 40 | +This module intends to provide exactly the same API as Node.js, so features that are not available in the core `util` module will not be accepted. Feature requests should instead be directed at [nodejs/node](https://github.com/nodejs/node) and will be added to this module once they are implemented in Node.js. |
| 41 | + |
| 42 | +If there is a difference in behaviour between Node.js's `util` module and this module, please open an issue! |
| 43 | + |
| 44 | +## License |
| 45 | + |
| 46 | +[MIT](./LICENSE) |
14 | 47 |
|
15 |
| -This module also works in modern browsers. If you need legacy browser support you will need to polyfill ES5 features. |
| 48 | +[util]: https://nodejs.org/docs/latest-v8.x/api/util.html |
0 commit comments