heir

Heir

Helper functions for prototypical inheritance in JavaScript.

Use the source code and JSDoc comments as documentation, here's a quick example to get you started.

const heir = require('heir')

// Create the base class.
function Base() {}

// Add a method.
Base.prototype.foo = function () {
  return 'Base#foo'
}

// Create a sub class which inherits from base.
function Sub() {}
heir.inherit(Sub, Base)

// Mix in some functionality enhancing objects.
heir.mixin(Sub, events)
heir.mixin(Sub, pooling)

// Change the original method.
Sub.prototype.foo = function () {
  return [
    'Sub#foo',
    Sub._super.foo.call(this)
  ].join(', ')
}

// Create an instance of Sub and call it's method.
const s = new Sub()
s.foo() // Returns "Sub#foo, Base#foo"

Unlicense

This project is given to you under the unlicense, as documented in the UNLICENSE file in this directory. Enjoy.

Changelog

v4.0.0

• Cleaned up the project to match how JavaScript projects are usually structured these days.
• Fixed some documentation.
• Moved away from bower.
• Simplified as much as possible.
• Removed all the AMD stuff, just use webpack or whatever, module.exports and require is good enough and can be compiled out.
• Use const over var, if you really need something to target an old browser etc use a transpiler or v3.0.0.
• Deleted a LOT of code because YAGNI.