https://github.com/cj/class.js

High performance class implementation for nodejs
https://github.com/cj/class.js

Last synced: 2 months ago
JSON representation

High performance class implementation for nodejs

• Host: GitHub
• URL: https://github.com/cj/class.js
• Owner: cj
• Created: 2010-05-31T18:15:31.000Z (about 16 years ago)
• Default Branch: master
• Last Pushed: 2010-04-08T22:35:57.000Z (over 16 years ago)
• Last Synced: 2026-02-19T22:38:39.556Z (5 months ago)
• Language: JavaScript
• Homepage:
• Size: 103 KB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: Readme.md
  • Changelog: History.md

Awesome Lists containing this project

README

          

# Class.js

  High performance classical inheritance for **node.js**.

## Installation

  Install the [Kiwi package manager for nodejs](http://github.com/visionmedia/kiwi)

  and run:

  

      $ kiwi -v install class

## About Class.js

Without wasting performance on cross-browser functionality,

class.js is an **extremely light** (_20-ish SLOC_) class implementation.

By utilizing idiomatic prototypal inheritance techniques this

implementation is **very fast**. There are no wrapping or _super_ 

hacks involved.

## Features

  * Fast

  * Tiny

  * Mixin support with included() hook

  * Subclassing support with extended() hook

## Examples

    var Class = require('class').Class

    var User = new Class({

      extend: {

        extended: function(subclass){

          // called when User.extend() is called,

          // in this case passes Admin

        }

      },

      constructor: function(name){

        this.name = name

      },

      toString: function(){

        return '[User ' + this.name + ']'

      }

    })

    

    var Admin = User.extend({

      constructor: function(name) {

        User.call(this, name.toUpperCase())

      }

    })

    

    var SomeMixin = new Class({

      extend: {

        included: function(superclass){

          // called when Admin.include()

          // is called, in this case Admin

          // will become the contents of "superclass"

        }

      },

      foo: 'bar'

    })

    

    Admin.include(SomeMixin)

    

    puts(new Admin('tj'))

    // => "[User TJ]"

    

## Benchmarks

Currently the benchmarks compare regular **prototypal inheritance**,

node's **sys.inherits()**, and **class.js**. Each subclasses _User_

as _Admin_, and creates an instance **500,000 times**.

    λ  class.js: node benchmark.js

    running 500000 times

    prototype : 68 ms

    sys.inherits() : 1512 ms

    class.js : 2510 ms

## Running Tests

Specs are written using [JSpec](http://jspec.info), however

no additional installations are required as JSpec is froozen

to _spec/lib_, just simply run:

    $ make test

## License 

(The MIT License)

Copyright (c) 2009 TJ Holowaychuk <tj@vision-media.ca>

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.