7c2e73f53a | ||
---|---|---|
.. | ||
example | ||
lib | ||
test | ||
.gitignore | ||
README.md | ||
index.js | ||
package.json |
README.md
asteroid-module
v0.0.1
About
An AsteroidModule
is an abstract class that provides a base for all asteroid modules. Its constructor takes an options
argument provided by a config.json
. It is also supplied with dependencies it lists on its constructor based on information in the config.json
file.
Example
See resource for an example asteroid module.
AsteroidModule.dependencies
An asteroid module may define dependencies on other modules that can be configured in config.json
. Eg. the collection module defines a model dependency.
Collection.dependencies = {
model: 'model'
}
A configuration then must define:
{
"dependencies": {
"model": "some-model-module"
}
}
Where some-model-module
is an existing model
instance.