Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
JavaScript
Tree: 5357203da1

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
docs
lib
test
.travis.yml
LICENCE
Makefile
README.md
npm-debug.log
package.json

README.md

pd Build Status

Helping you do prototypical OO

Status: production ready

Example

var Animal = {
    legs: 4,
    walk: function () { ... }
};

var Cat = pd.extend(Object.create(Animal), {
    nyan: function () { ... },
    constructor: function () { this.lives = 9; return this; }
});

var cat = Object.create(Cat).constructor();

Motivation

ES5 OO is verbose

pd solves this with utilities and sugar.

Blog Posts

Documentation

pd (obj)

pd converts all the values of your objects properties into property descriptors of those values.

pd({
    "foo": "bar"
})

is the same as

{
    "foo": {
        "value": "bar",
        "enumerable": true,
        "writable": true,
        "configurable": true
    }
}

pd.extend (obj..)

pd.extend extends an object with other objects. key clashes are given right preference

pd.extend(
    {
        "one": "faz",
        "three": "bar"
    },
    {
        "two": "ni",
        "three": "baz"
    },
    {
        "three": "bas",
        "four": "four"
    }
);

is the same as

{
    "one": "faz",
    "two": "ni",
    "three": "bas",
    "four": "four"
}

pd.extend returns the first object you pass in.

pd.bindAll (obj..)

pd.bindAll is similar to underscore's bindAll method. It takes an object and binds all it's methods to the object. It takes an optional list of objects to mix in

var o = {
    constructor() { 
        pd.bindAll(this, {
            draw: function () { 
                /* use `this` with its "correct" value, i.e. `o` */
            }
        });
    },
    start: function (eventEmitter) {
        // note `this.draw` would not work correctly if it wasn't bound
        eventEmitter.on("draw", this.draw);
    }
};

pd.Name

pd.Name constructs a Name function. This name function when passed your object will return a privates object. This privates object cannot be accessed in any other way then calling Name.

Example:

var Klass = (function () {
    var privates = pd.Name();

    return {
        constructor: function (secret) {
            privates(this).secret = secret;
        },
        getSecret: function () {
            return privates(this).secret;
        }
    };
}());

Installation

npm install pd

Test

make test

Contributors

  • Raynos
  • Gozala

MIT Licenced

Something went wrong with that request. Please try again.