Package Exports

express-enrouten

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (express-enrouten) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

express-enrouten

Route configuration middleware for expressjs.

API

`app.use(enrouten(options))`

var express = require('express'),
    enrouten = require('express-enrouten');

var app = express();
app.use(enrouten({ ... });

Deprecated: `enrouten(app).withRoutes(options)`

var express = require('express'),
    enrouten = require('express-enrouten');

// Legacy API - do not use
//var app = express();
//enrouten(app).withRoutes({ ... });

Configuration

express-enrouten supports routes via configuration and convention.

app.use(enrouten({
        method: 'get',
        path: '/foo',
        handler: function (req, res) {
            // ...
        }
    }]
});

directory (optional) - String or array of path segments. Specify a directory to have enrouten scan all files recursively to find files that match the controller-spec API.

app.use(enrouten({
    directory: 'controllers'
});

routes (optional) An array of route definition objects. Each definition must have a path and handler property and can have an optional method property (method defaults to 'GET').

app.use(enrouten({
    routes: [
        { path: '/',    method: 'GET', handler: require('./controllers/index') },
        { path: '/foo', method: 'GET', handler: require('./controllers/foo') }
    ]
});

index (optional, overrides directory and disables scanning) - String path or array of path segments indicating the file to load which acts as the route 'index' of the application.

// index.js
module.exports = function (app) {

    app.get('/', index);
    app.get('/account', passport.protect, account);

    // etc...
};

Controller Files

A 'controller' is defined as any require-able file which exports a function that accepts a single argument. Any files with an extension of .js (or .coffee if CoffeeScript is registered) will be loaded and if it exports a function that accepts a single argument then this function will be called. NOTE: Any file in the directory tree that matches the API will be invoked/initialized with the express application object.

// Good :)
// controllers/controller.js
module.exports = function (app) {
    app.get('/', function (req, res) {
        // ...
    });
};

// Bad :(
// Function does not get returned when `require`-ed, use `module.exports`
exports = function (app) {
    // ...
};

// Bad :(
// controllers/other-file-in-same-controller-directory.js
modules.exports = function (config) {
    // `config` will be the express application
    // ...
};

// Acceptable :)
// controllers/config.json - A non-js file (ignored)
// controllers/README.txt - A non-js file (ignored)
// controllers/util.js - A js file that has a different API than the spec (ignored)
module.exports = {
    importantHelper: function () {

    }
};