CloudFlareJS

CloudFlareJS is a robust and highly performant API for placing your JavaScript on the page and safely resolving all of its dependencies.

API Documentation (BETA)

CloudFlare.require

The require function is used when you want to retrieve and make use of modules. You give it a list of modules, and a callback which will get called when those modules are done being retrieved. Scripts corresponding to the list of modules requested are guaranteed to load asynchronously, and in as few requests as possible.

CloudFlare.require(modules, callback);

• modules. An array of string module names. The resolved modules are passed in this order as arguments to the callback function.
• callback. Callback function that receives the resolved modules in the requested order. Modules that failed to resolve are passed as undefined.

CloudFlare.require(["foo", "bar", "baz"], function(foo, bar, baz) {
  // If foo, bar and baz correspond to modules,
  // they will be defined here.
});

CloudFlare.define

Defines a new module that can later be required. When you define a module, you provide a name for the module, an optional list of dependency modules and an initializer function that returns the module you are defining. Scripts corresponding to the list of module dependencies are guaranteed to load asynchronously, and in as few requests as possible.

CloudFlare.define(name, [dependencies,] initializer);

• name. The name of the defined module by which other other modules can require this one.
• dependencies. This is an optional array of dependencies. These dependencies will be resolved and passed as arguments to the initializer function in the order they are requested. Modules that failed to resolve are passed as undefined.
• initializer. This function will be called after all modules listed in dependencies have been resolved. It will receive any dependencies, if specified, as arguments in the order they were requested. The function is responsible for defining the module and will return an object representing the defined module, unless that module failed to be resolved on account of a thrown exception or not existing.

CloudFlare.define("mymodule", ["foo", "bar"], function(foo, bar) {
  function someMethod() {
    return foo.fooMethod() + bar.CONSTANT;
  };

  return {
    someMethod: someMethod
  };
});