This specification addresses how modules should be written in order to be interoperable among a class of module systems that can be both client and server side, secure or insecure, implemented today or supported by future systems with syntax extensions. These modules are offered privacy of their top scope, facility for importing singleton objects from other modules, and exporting their own API. By implication, this specification defines the minimum features that a module system must provide in order to support interoperable modules.
require
is a Function- The
require
function accepts a module identifier. require
returns the exported API of the foreign module.- If there is a dependency cycle, the foreign module may not have
finished executing at the time it is required by one of its
transitive dependencies; in this case, the object returned by
require
must contain at least the exports that the foreign module has prepared before the call to require that led to the current module's execution. - If the requested module cannot be returned,
require
must throw an error. - The
require
function may have amain
property.- This attribute, when feasible, should be read-only, don't delete.
- The
main
property must either be undefined or be identical to themodule
object in the context of one loaded module. - The
require
function may have apaths
attribute, that is a prioritized Array of path Strings, from high to low, of paths to top-level module directories.- The
paths
property must not exist in "sandbox" (a secured module system).
- The
- The
paths
attribute must be referentially identical in all modules.- Replacing the
paths
object with an alternate object may have no effect. - If the
paths
attribute exists, in-place modification of the contents ofpaths
must be reflected by corresponding module search behavior. - If the
paths
attribute exists, it may not be an exhaustive list of search paths, as the loader may internally look in other locations before or after the mentioned paths. - If the
paths
attribute exists, it is the loader's prorogative to resolve, normalize, or canonicalize the paths provided.
- Replacing the
- The
- In a module, there is a free variable
require
, which conforms to the above definiton. - In a module, there is a free variable called
exports
, that is an object that the module may add its API to as it executes.- modules must use the
exports
object as the only means of exporting. - In a module, there must be a free variable
module
, that is an Object. - The
module
object must have aid
property that is the top-levelid
of the module. Theid
property must be such thatrequire(module.id)
will return the exports object from which themodule.id
originated. (That is to say module.id can be passed to another module, and requiring that must return the original module). When feasible this property should be read-only, don't delete. - The
module
object may have auri
String that is the fully-qualified URI to the resource from which the module was created. Theuri
property must not exist in a sandbox.
- modules must use the
- A module identifier is a String of "terms" delimited by forward slashes.
- A term must be a camelCase identifier,
.
, or..
. - Module identifiers may not have file-name extensions like
.js
. - Module identifiers may be "relative" or "top-level". A module
identifier is "relative" if the first term is
.
or..
. - Top-level identifiers are resolved off the conceptual module name space root.
- Relative identifiers are resolved relative to the identifier of the
module in which
require
is written and called.
This specification leaves the following important points of interoperability unspecified:
- Whether modules are stored with a database, file system, or factory functions, or are interchangeable with link libraries.
- Whether a PATH is supported by the module loader for resolving module identifiers.