occaecatidicta/packages/omelox-loader/README.md

[![Build Status](https://travis-ci.org/node-omelox/omelox-loader.svg?branch=master)](https://travis-ci.org/node-omelox/omelox-loader)

#omelox-loader - loader module for omelox

Load codes for omelox based on the convention over configuration rules.

omelox-rpc could load modules in batch but not load the sub-directory recursively.

+ Tags: node.js

##Regulation
Module name

Module would use the filename by default. For example: load ```lib/a.js``` and the return result would be: ```{a: require('./lib/a')}```

It would use the name if the module with a name property. For example

```javascript
a.js
exports.name = 'test';
```
the return result would be: ```{test: require('./lib/a')}```

Module definiation

If the module exported as a function, omelox-loader would take it as a factory method and generate a new instance of module by calling the function. And it would return the module directly for other situation.

```javascript
module.exports = function(context) {
	return {};	// return some module instance
};
```

##Installation
```
npm install omelox-loader
```

##Usage
``` javascript
var Loader = require('omelox-loader');

var res = Loader.load('.');
console.log('res: %j', res);
```

##API
###Loader.load(path, context)
Load all modules in the path.
####Parameters
+ path loaded path
+ context if the module provides a factory method, the context would be pass as a parameter as the factory method.