Skip to content

Commit 832546d

Browse files
committed
Update readme.
1 parent 2c65d29 commit 832546d

File tree

1 file changed

+39
-6
lines changed

1 file changed

+39
-6
lines changed

README.md

Lines changed: 39 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,48 @@
1-
# util
1+
# util [![Build Status](https://travis-ci.org/defunctzombie/node-util.png?branch=master)](https://travis-ci.org/defunctzombie/node-util)
22

3-
[![Build Status](https://travis-ci.org/defunctzombie/node-util.png?branch=master)](https://travis-ci.org/defunctzombie/node-util)
3+
> Node.js's [util][util] module for all engines.
44
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.
66

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:
812

913
```shell
1014
npm install util
1115
```
1216

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)
1447

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

Comments
 (0)