bluebirds/README.md

Object oriented Node.js toolset

[![Build Status](https://travis-ci.org/BlueBirdsCorp/BB.js.svg?branch=master)](https://travis-ci.org/BlueBirdsCorp/BB.js)

# BB.js

## Object oriented Node.js toolset




### Installation
```shell
$ npm install bluebirds --save
```


### Usage
```javascript
var BB = require('bluebirds');
```


### Modules

#### BB.Object
Core piece of this toolset, BB.Object provides an "Ember" style object model for creating classes.

_BB.Object.prototype.init_

_BB.Object.extend_

_BB.Object.create_


Create your first class :
``` javascript
var Person = BB.Object.extend({
  firstName: '',
  lastName: '',
  
  init: function() {
    if(!this.lastName || !this.firstName) throw new Error('John Doe is a myth');
  },
  
  sayHello: function() {
    console.log('Hello, my name is', this.getFullName());
  },
  
  getFullName: function() {
    return this.firstName + ' ' + this.lastName;
  }
});


var person = Person.create({
  firstName: 'Sylvain',
  lastName: 'Estevez'
});

person.sayHello();
```

``` shell
$ Hello, my name is Sylvain Estevez
```

Extend your class :
``` javascript
var Employee = Person.extend({
  job: '',
  
  sayHello: function() {
    console.log(this._super(), ', I work as a ', this.job);
  }
});


var employee = Employee.create({
  firstName: 'Sylvain',
  lastName: 'Estevez',
  job: 'developer'
});

employee.sayHello();
```

``` shell
$ Hello, my name is Sylvain Estevez, I work as a developer
```