Cls

An interface for classical object oriented programming in JavaScript.

API

Creating a class with Cls

1var Slideshow, sshow;
2
3Slideshow = Cls({
4  methods: {
5    constructor: function(slides, effect) {
6      this.slides = slides;
7      this.effect = effect;
8    },
9    goTo: function(slide) {
10      domSelector('#id').nextSlide(slide, this.effect);
11    }
12  },
13  statics: {
14    version: '0.0.1'
15  }
16});
17
18sshow = new Slideshow(['top_story', 'sport', 'politics'], 'fade');

Extending that class

1var MegaSlideshow, mshow;
2
3MegaSlideshow = Cls({
4  uber: Slideshow,
5  methods: {
6    goTo: function(slide) {
7      var that = this;
8
9      this.changePageTitle(slide, function() {
10        that.inherited('next');
11      });
12    }
13  }
14});

Mixins

You can override / add methods to a class/object (any object) using Cls.mixin(obj, { /* methods */ }):

1var laptop = {
2  os: 'OSX Lion',
3  processor: 'i5'
4};
5
6laptop = Cls.mixin(laptop, { memory: '8GB', cores: 5 });

Environments

You can use Cls in the browser or in a Node.js app.

In the browser

1<script src="path/to/cls.js"></script>
2<!-- Cls() is exposed as a global var -->
3
4<script type="text/javascript">
5  var Foo = Cls({ ... });
6  ...
7</script>

Node.js

1var Cls = require('Cls');
2
3var Foo = Cls({ ... });

Install the Package!

Install the package with npm manually or by including the app into your package.json dependencies.

$ npm install Cls

// then, in your Node app
var Cls = require('Cls')

Developers

$ npm install .
$ npm test
$ npm run-script build

Only edit the file src/cls.js. For more examples check test/tests.js.

Why did I write this library?

• prototype is a long word
• People are used to classes from other languages
• Although CoffeeScript's Class implementation is nice, if you have 10 files that use OOP the __extends function is defined 10 times
• I don't like the functionality provided by most of the similar OOP libraries or I consider them bloated

Bonus - for CoffeeScript fans

1log = console.log
2Cls = require './cls'
3
4Animal = Cls
5  methods:
6    constructor: (@name) ->
7
8    move: (meters) ->
9      log "#{@name} moved #{meters} meters"
10
11  statics:
12    types: ['vertebrates', 'invertebrates']
13
14Snake = Cls
15  uber: Animal
16  methods:
17    move: ->
18      log "Slithering..."
19      setTimeout =>
20        this.inherited 'move', [5]
21      , 300
22
23Horse = Cls
24  uber: Animal
25  methods:
26    move: ->
27      log "Galloping..."
28      args = arguments
29      setTimeout =>
30        this.inherited 'move', args
31      , 1500
32
33sam = new Snake "Sammy the Python"
34tom = new Horse "Tommy the Palomino"
35
36sam.move()
37tom.move(45)