csextends

Coffee-Script Extends

Use the Coffee-Script extends keyword outside of Coffee-Script. Useful for easily extending existing existing classes, e.g. require('csextends')(klass, extensions), and for providing your module consumers with an easy way to extend your classes, i.e. Backbone.Model.extend(extensions).

Install

NPM

• Use: require('csextends')
• Install: npm install --save csextends

Browserify

• Use: require('csextends')
• Install: npm install --save csextends
• CDN URL: //wzrd.in/bundle/csextends@1.0.2

Ender

• Use: require('csextends')
• Install: ender add csextends

Usage

// Create a Class
var Person = function(name){
	this.name = name
}
Person.prototype.name = 'Unknown'
Person.prototype.hello = function(){
	console.log('Hello '+this.name+'!')
}

// Extend the class
var Child = require('csextends')(Person, {
	constructor: function(name, mother, father){
		this.name = name
		this.mother = mother
		this.father = father
	},
	mother: null,
	father: null,
	heyYaAll: function(){
		this.hello()
		this.mother.hello()
		this.father.hello()
	}
})

// Create some people
var eve = new Person('Eve')
var adam = new Person('Adam')
var me = new Child('me', eve, adam)
me.heyYaAll()
// Hello me!
// Hello Eve!
// Hello Adam!

// Is me still a person
console.log(me instanceof Person)  // true


// Now let's make this easier for people in the future
Person.prototype.subclass = require('csextends')
// Now, instead of doing:
//   var Child = require('csextends')(Person, extensions)
// We can now do:
//   var Child = Person.subclass(extensions)
// Which is very useful for module consumers.

// If you use CoffeeScript, you can accomplish the above by doing:
// class Person
//   @subclass: require('csextends')
// Then your javascript consumers can do:
//   var Child = Person.subclass(extensions)
// Just as before, which is really good for JavaScript users.

History

Discover the change history by heading on over to the HISTORY.md file.

Contribute

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

Backers

Maintainers

These amazing people are maintaining this project:

• Benjamin Lupton [e-mail] (https://github.com/balupton)

Sponsors

No sponsors yet! Will you be the first?

Contributors

These amazing people have contributed code to this project:

• Benjamin Lupton [e-mail] — view contributions

Become a contributor!

License

Licensed under the incredibly permissive MIT license

Copyright © 2013+ Bevry Pty Ltd [e-mail] (http://bevry.me)

Changelog

v1.0.2 2014 July 3

• Renamed from extendonclass to csextends
• Added the ability to specify the parent class via an argument