trotter / central-dispatch
watch download tarball
public
Forks0Right
Watchers3Right
Description: Cross-site JavaScript library
Homepage:
Clone URL: git://github.com/trotter/central-dispatch.git
name age
history
message
file MIT-LICENSE.txt Loading commit data...
file README.textile
directory js/
README.textile

CentralDispatch

CentralDispatch is a totally awesome replacement for JSONP. It pushes the
callback matching work to the client, but allows for server side caching of JSON
data. This is a huge benefit if you’re aggressively caching your application.

Client Side Usage

CentralDispatch.requestData(url, callback, options)

Parameters

param expected type description
url String The url from which you’re fetching data
callback Function or Hash A function that will be called when the data is received, or a hash described below

Options Hash:
| key | expected type | description |
| onSuccess | Function | A function to be called when the data is received |
| onError | Function | A function to be called if there is an error fetching the data |

Example


var callback = function (data) {
    alert(data);
};
CentralDispatch.requestData('http://trottercashion.com/examples/cdData.js', callback)

var errorCallback = function (msg, url, line) {
    alert("error: " + msg);
}

Server Side Usage

On the server, all JSON data must be wrapped in CentralDispatch.receiveData,
which is described below.

CentralDispatch.receiveData(version, url, data)

Parameters

param expected type description
version String The version of CentralDispatch.receiveData you’re using, currently only v1
url String The url where the data resides, can be a path fragment
data JSON The JSON data

Examples


CentralDispatch.receiveData('v1', 'http://trottercashion.com/examples/cdData.js', {foo: bar});
CentralDispatch.receiveData('v1', 'examples/cdData.js', {foo: 'bar'});