module.js

The actions method contains code to be executed when run is called.  This method is a placeholder to be overwritten.

 MyModule.actions = function() {
  // define actions here
};

Waits for the DOM to load then calls execute.

MyModule.run();

Waits for the DOM to be ready and then executes a callback.

Parameters

MyModule.call_on_ready(function() {
   // some code to execute when the DOM is ready
});

Wrapper method that set’s up the environment and then calls actions.

MyModule.execute();

Method to define module elements.

Parameters

MyModule.elements(function() {
   // element definitions go here
});

Adds properties to the module’s data object.

Parameters

MyModule.set_data('some_key', 'some_value');
MyModule.data.some_key === 'some_value'

MyModule.set_data({
   'property_one': 'value_one',
   'property_two': 'value_two'
});
MyModule.data.property_one === 'value_one'
MyModule.data.property_two === 'value_two'

Adds a test file to the tests array (beta).

Parameters

MyModule.add_test('mytest.test.js');

Runs the test files in the test array.  This method is automatically called by the execute method if run_tests === true