my-express-module-loader v2.0.1

my-express-module-loader

A dynamic module loader. Focused mainly on being able to scan a directory for modules and mount routes on an express app if wanted

Installation

npm install my-express-module-loader

Usage

var app = require("express")();
var loader = require("my-express-module-loader");

loader(app);

API

var loader = require("my-express-module-loader");
loader(app, options);

loader(app, options)

• app (express.application) - Passed to every loaded module for dependency injections and stuff like that. The modules are assumed to export one of:
  • a plain object with properties
  • a function prototype.
• options (Optional) Object.
  • dirname (String) - The path on where to search for modules. This option is passed directly to requireindex. Default: $CWD/lib.
  • loadExpressRouters (Boolean) - Set to false if you don't want this module to app.use() automatically the exported .router property on every found module. Default: true.
  • router - An express Router on which to load the modules. i.e. overrides route loading on app object.

LICENSE

The MIT License (MIT)

Copyright (c) 2015 Oscar López <oskosk@gmail.com>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.