BlueGit

blue-star danique-bot

Files

danique-bot / node_modules / inherits / README.md

README.md

Import template
timfa Tim · pushed by timfa · 4 years ago
c788ad20 History
README.md 1.6 KiB Download Raw

Browser-friendly inheritance fully compatible with standard node.js inherits.

This package exports standard inherits from node.js util module in node environment, but also provides alternative browser-friendly implementation through browser field. Alternative implementation is a literal copy of standard one located in standalone module to avoid requiring of util. It also has a shim for old browsers with no Object.create support.

While keeping you sure you are using standard inherits implementation in node.js environment, it allows bundlers such as browserify to not include full util package to your client code if all you need is just inherits function. It worth, because browser shim for util package is large and inherits is often the single function you need from it.

It's recommended to use this package instead of require('util').inherits for any code that has chances to be used not only in node.js but in browser too.

usage

var inherits = require('inherits');
// then use exactly as the standard one

note on version ~1.0

Version ~1.0 had completely different motivation and is not compatible neither with 2.0 nor with standard node.js inherits.

If you are using version ~1.0 and planning to switch to ~2.0, be careful:

  • new version uses super_ instead of super for referencing

superclass

  • new version overwrites current prototype while old one preserves any

existing fields on it

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