0.1.3 • Published 10 years ago
classified v0.1.3
#Classified
Real OOP for Javascript.
Installation
$ npm install classified
For client side you can just include the index.js
Usage
Node
var classified = require('classified');
classified();
RequireJS
var classified = require(['classified'], function(classified) {});
jQuery
jQuery.classified();
Client Side
classified();
Quick Start
var classified = require('classified');
//root definition
var RootClass = classified({
//constants
SOME_CONSTANT: 'foo',
//public properties
sampleProperty: 4.5,
//protected properties
_sampleProperty: 5.5,
//private properties
__sampleProperty: 6.5,
//constructor
___construct: function() {
this.constructCalled = true;
},
//public methods
sampleMethod: function() {
return this._sampleMethod();
},
//protected methods
_sampleMethod: function() {
return this.__sampleMethod();
},
//private methods
__sampleMethod: function() {
return this.SOME_CONSTANT + this._sampleProperty;
}
});
//child definition
//you can use object or function as the definition
var ChildClass = RootClass.extend(function() {
//constants
this.SOME_CONSTANT_2 = 'bar';
//protected properties
this._sampleProperty = 7.5;
//public methods
this.sampleMethod = function() {
return this._sampleMethod();
};
//protected methods
this._sampleMethod = function() {
return this.___parent._sampleMethod();
};
});
//instantiate child
var child = ChildClass.load();
//test it
console.log(child.sampleMethod()); //--> foo7.5
try {
child._sampleMethod();
} catch(e) {
console.log('Protected call did not work');
}
Features
- Public, Private, Protected
- Constants
- Inheritance
- Traits
- Works on server or client
- Circular Dependencies Ready
- Node asyncrounous protected and private support
Methods
- define(object|function) - Defines the class
- extend(object|function) - Adds a parent to be combined with the definition
- definition() - Returns the entire definition including the protected and private properties
- parents() - Returns direct parents of this definition
- get() - Returns the publically accessable class definition function
- load() - Returns class defined instantiation
- register(string) - saves a state of the definition which can be recalled in trait
- trait(string|function|object) - will setup the provided as a parent, if string will recall from registry
What's up with the underscores?
- _ - protected properties and methods
- __ - private properties and methods
- ___ - Magic placeholder (Waiting on harmony)
Node Async Support
Use ___freeze()
and ___unfreeze()
in Node for asyncronous patterns as in the example below.
classified(function() {
this._protectedValue = 4;
this.somethingToAsync = function() {
this.___freeze();
setTimeout(function() {
this._protectedValue = 5;
this.___unfreeze();
}.bind(this), 10);
};
});
0.1.3
10 years ago
0.1.2
10 years ago
0.1.1
10 years ago
0.1.0
10 years ago
0.0.17
10 years ago
0.0.16
10 years ago
0.0.15
10 years ago
0.0.14
10 years ago
0.0.13
10 years ago
0.0.12
10 years ago
0.0.11
10 years ago
0.0.10
10 years ago
0.0.9
10 years ago
0.0.8
10 years ago
0.0.7
10 years ago
0.0.6
10 years ago
0.0.4
10 years ago
0.0.3
10 years ago
0.0.2
10 years ago
0.0.1
10 years ago