« Home / All Guides

IMPORTANT: This guide is not ready to yet, please go away.

Object oriented programming is a fairly well-understood approach to write maintainable Software. Even so JavaScript does not explicetly favor OOP, it makes it easy enough to use it.

To help with some common tasks, I recommend that you use the 'oop' module. (Disclaimer: I'm the author of the oop module.)

Basic Example

Here is a basic example of a node.js class. The later parts of this document will explore various concepts behind it.

var oop = require('oop'); var EventEmitter = require('events').EventEmitter;

function KitchenTimer(properties) {   this.interval = null;   this.timeout = null;   this.minutes = null;   this.start = null;

  oop.inherits(this, EventEmitter);   oop.mixin(this, properties); }

KitchenTimer.SECOND = 1000; KitchenTimer.MINUTE = KitchenTimer.SECOND * 60;

KitchenTimer.create = function(minutes) {   var timer = new KitchenTimer();   timer.set(minutes);   return timer; }

KitchenTimer.prototype.set = function(minutes) {   var ms = minutes * KitchenTimer.MINUTE;   this.timeout = setTimeout(this.ring.bind(this), ms);   this.interval = setInterval(this.tick.bind(this), KitchenTimer.SECOND);

  this.minutes = minutes;   this.start = new Date(); };

KitchenTimer.prototype._tick = function() {   this.emit('tick'); };

KitchenTimer.prototype._ring = function() {   this.emit('ring');   this.reset(); }

KitchenTimer.prototype.reset = function() {   clearTimeout(this.timeout);   clearInterval(this.interval);

  oop.reset(this); }

KitchenTimer.prototype.remaining = function() {   var ms = (new Date() - this._start);   var minutes = ms / KitchenTimer.MINUTE;   return minutes; };