loopback/node_modules/asteroid-module
Ritchie Martori 7c2e73f53a Initial working store, model, connection, and collection 2013-04-10 10:55:13 -07:00
..
example Update gitignore to allow node_modules 2013-04-09 11:33:29 -07:00
lib Update gitignore to allow node_modules 2013-04-09 11:33:29 -07:00
test Update gitignore to allow node_modules 2013-04-09 11:33:29 -07:00
.gitignore Update gitignore to allow node_modules 2013-04-09 11:33:29 -07:00
README.md Initial working store, model, connection, and collection 2013-04-10 10:55:13 -07:00
index.js Update gitignore to allow node_modules 2013-04-09 11:33:29 -07:00
package.json Update gitignore to allow node_modules 2013-04-09 11:33:29 -07:00

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.