cla6

Cla6.js

Provides a class factory with additional functionality, like mixins and plugins. Although originally designed for use with Node.js and installable via npm install cla6, it can also be used directly in the browser.

Cla6 is also installable via:

• bower: bower install cla6

Basic Example

var Cla6 = require('cla6');

var Parent = Cla6('Parent', {
  constructor: function() {
    console.log('parent constructor');
  },

  parentMethod: function() {
    console.log('parent method');
  }
});

var Child = Cla6('Child').extend(Parent, {
  childMethod: function() {
    this.parentMethod();
    console.log('child method');
  },

  get accessor() {
    console.log('child getter');
  },

  set accessor(value) {
    console.log('child setter');
  }
});

child = new Child(); // parent constructor
child.childMethod(); // parent method, child method
child.accessor = child.accessor; // child getter, child setter

Why Use It

• Easy to use
• Easy to read
• Highliy compatible
• Defines classes THE RIGHT WAY

Unlike classic class definition, Cla6 defines unenumerable prototype properties:

// Classic class definition

function Klass() {
  this.foo = 'foo';
  this.bar = 'bar';
}

Klass.prototype.constructor = Klass;

Klass.prototype.baz = function() {
  return 'baz';
};

var instance = new Klass();

// prints foo, bar, baz
for (var k in instance)
  console.log(k);

// Cla6 class definition

var Klass = Cla6('Klass', {
  constructor: function() {
    this.foo = 'foo';
    this.bar = 'bar';
  },

  baz: function() {
    return 'baz';
  }
});

var instance = new Klass();

// prints foo, bar
for (var k in instance)
  console.log(k);

Mixins

Each class created by Cla6 can be extended using a mixin. Mixins can be applied at class creation or during run time.

var mixin1 = {
  method1: function() {
    console.log('mixin1');
  }
};

var mixin2 = {
  method2: function() {
    console.log('mixin2');
  }
};

var mixin3 = {
  method3: function() {
    console.log('mixin3');
  }
};

var Klass = Cla6('Klass', {
  constructor: function() {
    console.log("klass");
  },
}).mixin(mixin1, mixin2);

Klass.mixin(mixin3);

var obj = new Klass(); // klass
obj.method1(); // mixin1
obj.method2(); // mixin2
obj.method3(); // mixin3

Plugins

A plugin is a module which adds functionality to Cla6 and can be loaded dynamcally. Multipile plugins can be applied and will be called by their order of use.

Note, each plugin will affect the arguments for the next plugin in the plugins chain.

Cla6.use(plugin);

The official plugins currently available are:

• cla6-base
• cla6-hidden

Building a plugin

A basic plugin stracture should look like so:

var initialize = function(Cla6) {
  // initializer logic
};

var manipulate = function(descriptors, Parent) {
  // manipulator logic
};

module.exports = {
  initialize: initialize,
  manipulate: manipulate
};

• initialize - An optional initializer function which will be called with Cla6 instance once the plugin is used.
• manipulate - A required manipulator function which will be called every time before a class gets created with its descriptors and Parent class.

Download

The source is available for download from GitHub. Alternatively, you can install using Node Package Manager (npm):

npm install cla6