GrandCentral Features

GrandCentral is a component for quick and easy JSON dispatcher in JavaScript. Any module observing these JSON packets can retrieve only those it needs by identifying there pattern.

GrandCentral

A static class use to match and dispatch JSON.

GrandCentral.listen({
    status: 200,
    command: "friendstatus"
}, function(json) {
    /* update friend status */
});

GrandCentral.call({
    status: 200,
    command: "friendstatus",
    content: [
        {
            username: "user0",
            status: "online"
        },
        {
            username: "user42",
            status: "away"
        }
    ]
});

GrandCentral.listen()

• type: static
• input:
  • filter : Function || Object
  • handler : Function
• output: Central

Use a test function or a JSON pattern to match JSON packets. The handler will only receive JSON packets passed the test function or matched with the JSON pattern.

GrandCentral.listen(function(json) {
    return (json.status == 200 && json.command == "friendstatus")
}, function(json) {
    /* update friend status */
});

GrandCentral.listen({
    status: 200,
    command: "friendstatus"
}, function(json) {
    /* update friend status */
});

Default Operator

If no Operator is used, it will be considered as Default Operator in use. If the condition is an Array, Default Operator acts as in Operator; If the condition is a RegExp, Default Operator acts as re Operator; If the condition is a Function, Default Operator acts as f Operator. Otherwise, Default Operator acts as eq Operator.

GrandCentral.listen({
    value1: 42,
    value2: ["hello", "world"]
}, function(json) {
    /* will capture call below */
});

GrandCentral.call({
    value1: 42,
    value2: "world",
    value3: "other"
});

eq Operator

eq Operator is used to compare if two values are equal. For String, Number, and Boolean, the value is compared directly; For Array, every item in the Array is compared with eq Operator; For Obejct, every item in the Object is compared with Default Operator. For null and undefined, the value is compared directly.

GrandCentral.listen({
    value1$eq: "hello world",
    value2$eq: 42,
    value3$eq: true,
    value4$eq: ["hello", "world"],
    value5$eq: {
        value5_1: 42,
        value5_2: ["hello", "world"]
    }
}, function(json) {
    /* will capture call below */
});

GrandCentral.call({
    value1: "hello world",
    value2: 42,
    value3: true,
    value4: ["hello", "world"],
    value5: {
        value5_1: 42,
        value5_2: "world",
        value5_3: "other"
    },
    value6: "other"
});

ne Operator

eq Operator is used to compare if two values are not equal. It should equal to the opposite value of eq Operator.

GrandCentral.listen({
    value1$ne: "hello world",
    value2$ne: 42
}, function(json) {
    /* will capture call below */
});

GrandCentral.call({
    value1: "",
    value2: 24,
    value3: "other"
});

lt Operator

lt Operator is used to compae if the value is less than a specific value.

GrandCentral.listen({
    value1$lt: 0
}, function(json) {
    /* will capture call below */
});

GrandCentral.call({
    value1: -1,
    value2: "other"
});

lte Operator

lte Operator is used to compae if the value is less than or equal to a specific value.

GrandCentral.listen({
    value1$lte: 0,
    value2$lte: 0
}, function(json) {
    /* will capture call below */
});

GrandCentral.call({
    value1: -1,
    value2: 0,
    value3: "other"
});

gt Operator

gt Operator is used to compae if the value is greater than a specific value.

GrandCentral.listen({
    value1$gt: 0
}, function(json) {
    /* will capture call below */
});

GrandCentral.call({
    value1: 1,
    value2: "other"
});

gte Operator

gte Operator is used to compae if the value is greater than or equal to a specific value.

GrandCentral.listen({
    value1$gte: 0,
    value2$gte: 0
}, function(json) {
    /* will capture call below */
});

GrandCentral.call({
    value1: 1,
    value2: 0,
    value3: "other"
});

in Operator

in Operator is used to test if any item in the Array is equal to a specific value. eq Operator is used in the test.

GrandCentral.listen({
    value1$in: ["hello", "world"],
    value2$in: [{
        value2_1: 0
    }, {
        value2_1: 1
    }]
}, function(json) {
    /* will capture call below */
});

GrandCentral.call({
    value1: "world",
    value2: {
        value2_1: 0,
        value2_1: "other"
    },
    value3: "other"
});

nin Operator

nin Operator is used to test if none of the items in the Array is equal to a specific value. It should equal to the opposite value of in Operator.

GrandCentral.listen({
    value1$nin: ["hello", "world"],
    value2$nin: [{
        value2_1: 0
    }, {
        value2_1: 1
    }]
}, function(json) {
    /* will capture call below */
});

GrandCentral.call({
    value1: "",
    value2: {
        value2_1: -1,
        value2_1: "other"
    },
    value3: "other"
});

all Operator

all Operator is used to test if all items in an Array are in a specific Array. in Operator is used to test if an item is in the Array.

GrandCentral.listen({
    value1$all: ["hello", "world"]
}, function(json) {
    /* will capture call below */
});

GrandCentral.call({
    value1: ["hello", "and", "world"],
    value2: "other"
});

ex Operator

ex Operator is used to test if an item exists in a Object or not.

GrandCentral.listen({
    value1$ex: true,
    value2$ex: false
}, function(json) {
    /* will capture call below */
});

GrandCentral.call({
    value1: "hello world",
    value3: "other"
});

re Operator

re Operator is used to test if a String match a specific pattern in RegExp.

GrandCentral.listen({
    value1$re: /^A.*/
}, function(json) {
    /* will capture call below */
});

GrandCentral.call({
    value1: "A13579",
    value2: "other"
});

f Operator

f Operator is used to test if the value can pass a specific testing function.

GrandCentral.listen({
    value1$f: function(json) { return json.x > json.y; },
    value2$f: function(json) { return !json; }
}, function(json) {
    /* will capture call below */
});

GrandCentral.call({
    value1: {
        x: 1,
        y: 0
    },
    value2: false,
    value3: "other"
});

GrandCentral.call()

• type: static
• input:
  • json : Object
• output: Central

Send a JSON packet for dispatching.

GrandCentral.call({
    status: 200,
    command: "friendstatus",
    content: [
        {
            username: "user0",
            status: "online"
        },
        {
            username: "user42",
            status: "away"
        }
    ]
});

GrandCentral.extend()

• type: static
• input: target : Object
• output: target : Object

Extend an object and it will have the functionalities of GrandCentral.

GrandCentral.extend().listen()

• type: instance
• input:
  • filter : Function || Object
  • handler : Function
• output: this

Use a test function or a JSON pattern to match JSON packets. The handler will only receive JSON packets passed the test function or matched with the JSON pattern.

var controller = new Controller();

GrandCentral.extend(controller);

controller.listen(function(json) {
    return (json.status == 200 && json.command == "friendstatus")
}, function(json) {
    /* update friend status */
});

GrandCentral.extend().call()

• type: instance
• input:
  • json : Object
• output: this

Send a JSON packet for dispatching.

var controller = new Controller();

Central.extend(controller);

controller.call({
    status: 200,
    command: "friendstatus",
    content: [
        {
            username: "user0",
            status: "online"
        },
        {
            username: "user42",
            status: "away"
        }
    ]
});