API:require

From Spherical
Revision as of 10:26, 19 June 2017 by DaVince (talk | contribs) (Added lowercase template)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Sphere uses the CommonJS standard for dependency management. In CommonJS, each script is run as a function, which isolates modules from one another and enables more granular control of exports. In addition, because the code importing a module decides under what name to store the imports (if at all), naming conflicts between modules are avoided entirely.

Usage

require(module_id);

Loads a CommonJS module and returns its export table. `module_id` is an abstract path (a string) identifying the module to load, with the same semantics as in, e.g. Node.js. If the module cannot be found, an error will be thrown. The engine will look for modules in the following locations:

   @/lib/
   #/modules/

If require() is provided with a module ID beginning with either `./` or `../`, this indicates a path relative to the location of the calling module.