Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/nodejs/node.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat (limited to 'tools/eslint/node_modules/unherit/readme.md')
-rw-r--r--tools/eslint/node_modules/unherit/readme.md66
1 files changed, 66 insertions, 0 deletions
diff --git a/tools/eslint/node_modules/unherit/readme.md b/tools/eslint/node_modules/unherit/readme.md
new file mode 100644
index 00000000000..d7070923d3c
--- /dev/null
+++ b/tools/eslint/node_modules/unherit/readme.md
@@ -0,0 +1,66 @@
+# unherit [![Build Status][travis-badge]][travis] [![Coverage Status][codecov-badge]][codecov]
+
+Create a custom constructor which can be modified without affecting the
+original class.
+
+## Installation
+
+[npm][npm-install]:
+
+```bash
+npm install unherit
+```
+
+## Usage
+
+```js
+var EventEmitter = require('events').EventEmitter;
+
+/* Create a private class which acts just like
+ * `EventEmitter`. */
+var Emitter = unherit(EventEmitter);
+
+Emitter.prototype.defaultMaxListeners = 0;
+/* Now, all instances of `Emitter` have no maximum
+ * listeners, without affecting other `EventEmitter`s. */
+
+assert(new Emitter().defaultMaxListeners === 0); // true
+assert(new EventEmitter().defaultMaxListeners === undefined); // true
+assert(new Emitter() instanceof EventEmitter); // true
+```
+
+## API
+
+### `unherit(Super)`
+
+Create a custom constructor which can be modified without affecting the
+original class.
+
+###### Parameters
+
+* `Super` (`Function`) — Super-class.
+
+###### Returns
+
+`Function` — Constructor acting like `Super`, which can be modified
+without affecting the original class.
+
+## License
+
+[MIT][license] © [Titus Wormer][author]
+
+<!-- Definitions -->
+
+[travis-badge]: https://img.shields.io/travis/wooorm/unherit.svg
+
+[travis]: https://travis-ci.org/wooorm/unherit
+
+[codecov-badge]: https://img.shields.io/codecov/c/github/wooorm/unherit.svg
+
+[codecov]: https://codecov.io/github/wooorm/unherit
+
+[npm-install]: https://docs.npmjs.com/cli/install
+
+[license]: LICENSE
+
+[author]: http://wooorm.com