README.md (1625B)
1 Browser-friendly inheritance fully compatible with standard node.js 2 [inherits](http://nodejs.org/api/util.html#util_util_inherits_constructor_superconstructor). 3 4 This package exports standard `inherits` from node.js `util` module in 5 node environment, but also provides alternative browser-friendly 6 implementation through [browser 7 field](https://gist.github.com/shtylman/4339901). Alternative 8 implementation is a literal copy of standard one located in standalone 9 module to avoid requiring of `util`. It also has a shim for old 10 browsers with no `Object.create` support. 11 12 While keeping you sure you are using standard `inherits` 13 implementation in node.js environment, it allows bundlers such as 14 [browserify](https://github.com/substack/node-browserify) to not 15 include full `util` package to your client code if all you need is 16 just `inherits` function. It worth, because browser shim for `util` 17 package is large and `inherits` is often the single function you need 18 from it. 19 20 It's recommended to use this package instead of 21 `require('util').inherits` for any code that has chances to be used 22 not only in node.js but in browser too. 23 24 ## usage 25 26 ```js 27 var inherits = require('inherits'); 28 // then use exactly as the standard one 29 ``` 30 31 ## note on version ~1.0 32 33 Version ~1.0 had completely different motivation and is not compatible 34 neither with 2.0 nor with standard node.js `inherits`. 35 36 If you are using version ~1.0 and planning to switch to ~2.0, be 37 careful: 38 39 * new version uses `super_` instead of `super` for referencing 40 superclass 41 * new version overwrites current prototype while old one preserves any 42 existing fields on it