static-extend)

Adds a static extend method to a class, to simplify inheritance. Extends the static properties, prototype properties, and descriptors from a Parent constructor onto Child constructors.

Install

Install with npm:

``sh $ npm install static-extend --save`

`Usage`

`js var extend = require('static-extend');`

`API`

`$3`

Returns a function for extending the static properties, prototype properties, and descriptors from the Parent constructor onto Child constructors.

Params

* Parent{Function}: Parent ctor *extendFn{Function}: Optional extend function for handling any necessary custom merging. Useful when updating methods that require a specific prototype. *Child{Function}: Child ctor *proto{Object}: Optionally pass additional prototype properties to inherit. *returns {Object}

Example

`js var extend = require('static-extend'); Parent.extend = extend(Parent);

// optionally pass a custom merge function as the second arg Parent.extend = extend(Parent, function(Child) { Child.prototype.mixin = function(key, val) { Child.prototype[key] = val; }; });

// extend "child" constructors Parent.extend(Child);

// optionally define prototype methods as the second arg Parent.extend(Child, { foo: function() {}, bar: function() {} });`

`Contributing`

This document was generated by verb-readme-generator (a verb generator), please don't edit directly. Any changes to the readme must be made in .verb.md. See Building Docs.

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue. Or visit the verb-readme-generator project to submit bug reports or pull requests for the readme layout template.

`Building docs`

Generate readme and API documentation with verb:

`sh $ npm install -g verb verb-readme-generator && verb`

`Running tests`

Install dev dependencies:

`sh $ npm install -d && npm test``

Author

Jon Schlinkert

* github/jonschlinkert
* twitter/jonschlinkert

License

_This file was generated by verb, v0.9.0, on June 09, 2016._

API

$3

Returns a function for extending the static properties, prototype properties, and descriptors from the Parent constructor onto Child constructors.

Params

* Parent

 {Function}: Parent ctor
*

extendFn

 {Function}: Optional extend function for handling any necessary custom merging. Useful when updating methods that require a specific prototype.
*

Child

 {Function}: Child ctor
*

proto

 {Object}: Optionally pass additional prototype properties to inherit.
*

returns {Object}

Example

js
var extend = require('static-extend');
Parent.extend = extend(Parent);

// optionally pass a custom merge function as the second arg
Parent.extend = extend(Parent, function(Child) {
  Child.prototype.mixin = function(key, val) {
    Child.prototype[key] = val;
  };
});

// extend "child" constructors
Parent.extend(Child);

// optionally define prototype methods as the second arg
Parent.extend(Child, {
  foo: function() {},
  bar: function() {}
});

Contributing

This document was generated by verb-readme-generator (a verb generator), please don't edit directly. Any changes to the readme must be made in .verb.md. See Building Docs.

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue. Or visit the verb-readme-generator project to submit bug reports or pull requests for the readme layout template.