Package Exports

mixes

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (mixes) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

mixes

A minimal function to mixin functions and properties. This helps reduce the boilerplate and repetition of MyClass.prototype and Object.defineProperty.

Typical example:

var mixes = require('mixes')

function MyClass() {
    this._blah = 0
}

mixes(MyClass, {
    //mix in functions
    foo: function(a, b) { 
        return a + b
    },

    bar: function() {
    },

    //mix in property
    blah: {
        get: function() {
            return this._blah
        },
        set: function(blah) {
            this._blah = blah || 0
        }
    }
})

Using the class:

var m = new MyClass()
m.foo(a, b)
m.blah = 50

The same code would look like this in pure JS:

function MyClass() {
    this._blah = 0
}

MyClass.prototype.foo = function(a, b) {
    return a + b
}

MyClass.prototype.bar = function(a, b) {
}

Object.defineProperty(MyClass.prototype, "blah", {
    enumerable: true,
    configurable: true,
    get: function() {
        return this._blah
    },
    set: function(blah) {
        this._blah = blah || 0
    }
}

This is also nicer than the Blah.prototype = { ... } approach since it doesn't destroy your prototype chain (i.e. in the case of inheriting from a base class).

It also allows you to create collections of mixins easily:

var mixes = require('mixes')

function Dagger() {
}

mixes(Dagger, require('./mixins/item'))
mixes(Dagger, require('./mixins/weapon'))

Usage

`mixes(ctor, entries)`

For a constructor function or object with prototype, mixes in the given functions and properties. entries is an object with named functions or objects.

When an object is encountered, it is treated as a property and injected with Object.defineProperty. By default, configurable and enumerable are true if not specified, although you can override it like so:

mixes(Foo, {
    bar: {
        enumerable: true,
        writable: false,
        value: 5
    }
})

Other types (numbers, strings, etc) are ignored.

License

MIT, see LICENSE.md for details.