Class: Mixin

Source:

• Mixin.js, line 48

Examples

To define a Mixin class

const { Mixin } = require('tenkai')

class YourMixinClass extends Mixin {
	static init(obj, options) {
		// Do your initialisation here, like you would in a constructor.
		// obj is the new object, eqivalent of 'this'.
		// The user class can pass options, etc.
		obj.testValue = 'This is a Mixin Class'
	}

	// Add methods as per a standard class:
	mixinMethod() {
		...
		console.log('mixinMethod: '+this.testValue)
		...
	}
}

// Use the Mixin.export() function to export the class.
module.exports = Mixin.export(YourMixinClass)

To use a Mixin class

const YourMixinClass = require('./YourMixinClass')

class YourMixinUserClass {
	constructor(options = {}) {

		// Call the mixin with this and any options
		YourMixinClass(this, options)
	}

	anotherMethod() {
		// Now you can use the properties and methods on the mixin

		console.log(this.testValue)
		this.mixinMethod()
	}
}

module.exports = Mixin.export(YourMixinClass)