express-composer v1.0.3

express-composer

A composition library built by extending express

Modules

<a name="module_express-composer"></a>

express-composer

method for creating an express application with express-compose mixin

Example

var expressComposer = require('express-composer');

• express-composer
  • expressComposer() ⇒ app ⏏
    • static
      • .extend(app) ⇒ app
      • .handle(handlers, scopeProvider) ⇒ function
      • .error(handlers, scopeProvider) ⇒ function
      • .validate(validate, scopeProvider) ⇒ function
    • inner
      • ~scopeArg : Object | function | Promise.<Object>
      • ~requestHandlers : function | Array.<function()>
      • ~pathArg : String
      • ~appOptions : Object
      • ~routerOptions : Object
      • ~requestMethod : object
      • ~requestMethods : object
      • ~routeScore : Object
      • ~routerScore : Object
      • ~appScore : Object

expressComposer() ⇒ app ⏏

Creates an extended express app

Kind: Exported function
Example

var express = require('expressComposer'),
    app = express();

expressComposer.extend(app) ⇒ app

Extends an express app if it was not created with express-compose

Kind: static method of expressComposer

Example

var express = require('express'),
    expressComposer = require('express-composer'),
    app = express();
expressComposer.extend(app);

expressComposer.handle(handlers, scopeProvider) ⇒ function

Creates an express middle ware handler that will iterate through composers handlers

Kind: static method of expressComposer

expressComposer.error(handlers, scopeProvider) ⇒ function

Creates an express middle ware error handler that will iterate through composers error handlers

Kind: static method of expressComposer

expressComposer.validate(validate, scopeProvider) ⇒ function

Create an express middle ware that validates an incoming request

Kind: static method of expressComposer

expressComposer~scopeArg : Object | function | Promise.<Object>

Kind: inner typedef of expressComposer

expressComposer~requestHandlers : function | Array.<function()>

Kind: inner typedef of expressComposer

expressComposer~pathArg : String

Kind: inner typedef of expressComposer

expressComposer~appOptions : Object

Express application options passed into express

Kind: inner typedef of expressComposer
Properties

expressComposer~routerOptions : Object

Options passed into express Router{http://expressjs.com/api.html#router}

Kind: inner typedef of expressComposer
Properties

expressComposer~requestMethod : object

Kind: inner typedef of expressComposer
Properties

expressComposer~requestMethods : object

Kind: inner typedef of expressComposer
Properties

expressComposer~routeScore : Object

Kind: inner typedef of expressComposer
Properties

expressComposer~routerScore : Object

Kind: inner typedef of expressComposer
Properties

expressComposer~appScore : Object

Kind: inner typedef of expressComposer
Properties