useful Classical inheritance scaffolding, including singletons and easy to use mixin functionality
Install with component(1):
$ component install muigui/useful-Class
Install with npm:
$ npm install useful-Class
Class.define below for details of the
decriptor Object options.
The only difference between
Class.define is that
Class simply returns the constructor
Function and does not try to create a class namespace for it.
descriptor Object will contain all your properties and methods which will be added to your Class' prototype.
The descriptor has the following reserved property names:
|constructor||Function||This Class' constructor. This is the method that is called when you do: |
|extend||Function|String||OPTIONAL. If you want to inherit the properties and methods from an existing Class you reference the Class here.|
|accessors||Object||OPTIONAL. Each property in the |
|mixins||Object||OPTIONAL. An Object of properties and methods to mix into the Class' prototype.|
|module||Object||OPTIONAL. If you don't want the Class namespace to be created on the global context, then pass the Object to assign the class namespace to, e.g. a component or npm |
|chain||Boolean||OPTIONAL. Unless this is set explicitly to |
|singleton||Mixed||OPTIONAL. Whether or not this Class is a Singleton.|
If you want a Singleton set this property to be either
|__override__||Function||This is a reserved method name for overriding a |
|mixin||Function||This is a reserved method name for calling |
|original||Function||This is a special reserved method name used by overridden methods to call the original method they overrode.|
|parent||Function||This is a special reserved method for calling |
A factory method to allow you to:
Alias for the
Class.create method above.
Class matching the passed class namespace or
null if none is found.
true if the passed instance is an instance of the passed Class.
NOTE: This function uses
instanceof internally, the only extra thing it does is, if a
String is passed as the
Class parameter, try to find the matching constructor
These are the methods available on a newly created
create factory method is added to your Class constructor to allow you to:
See the Class Examples below on how to create
Class instances using the
create factory on your class or the
Alias for the
create method above.
When you create an instance of a Class created with
Class you can access the
super method of a Class you are extending by calling:
thisparent arg1 arg2 ... argN ;
Context will be maintained correctly, unless you use Function
.apply. In which case you should pass the context in as normal.
Class;Class;var Zaaz = Class;var foo = 'hello world!'bar = Classzaaz = Zaazcreate;foogreeting; // returns => "hello world!"foo === 10 // returns => truefoo === 100 // returns => truefoo === 100 // returns => truebargreeting; // returns => "bar: hello world!"bar === 10 // returns => truebar === 200 // returns => truefoo === 100 // returns => truezaazgreeting; // returns => "bar: zaaz: hello world!"zaaz === 10 // returns => truezaaz === 400 // returns => true
(The MIT License)
Copyright (c) 2011 christos "constantology" constandinou http://muigui.com
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.