OSjs Module Example

osjs-module-example.js

//
// Example: src/javascript/helpers/my-module.js
// Add to: `src/conf/200-compile.json`
// Then run: `grunt dist-dev-index` to add to dist-dev build
// Or: `grunt core` to add to dist build
//
(function(Utils, VFS, API) {

  /////////////////////////////////////////////////////////////////////////////
  // MODULE API
  /////////////////////////////////////////////////////////////////////////////

  // Just a basic pattern to keep methods
  var MyModule = {
    someMethod: function() {
    }
  };

  /////////////////////////////////////////////////////////////////////////////
  // EXPORTS
  /////////////////////////////////////////////////////////////////////////////

  // Available namespaces: API, VFS, Utils, Helpers, Core
  // Helpers is what I call the generic libraries... because they "help you"
  OSjs.Helpers.MyModule = MyModule;

})(OSjs.Utils, OSjs.VFS, OSjs.API);

//
// Then somewhere in your application code
// Just an example
//
MyApplication.prototype.something = function() {
  OSjs.Helpers.MyModule.someMethod();
};