Pd NPM | npm.io

pd

Helping you do prototypical OO

Status: production ready

Example

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

var Cat = Animal.make({
    nyan: function () { ... },
    constructor: function () { this.lives = 9; }
});

var cat = Cat.beget();

Motivation

ES5 OO is verbose

pd solves this with utilities and sugar.

Blog Posts

Documentation

pd (obj) link

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

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

is the same as

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

pd.extend (obj..) link

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, optionalWhitelist) link

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 whitelist parameter to only bind some methods

var o = {
    constructor() { 
        pd.bindAll(this, ["draw"]);
    }
    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 link</sup

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;
        }
    };
}());