Class ServerRouter

Hierarchy

ServerRouter

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ServerRouter(controllers: any, routes: RouteMap, options?: RouterOptions): ServerRouter

- Defined in components/router/router.ts:47
Parameters
- controllers: any
- routes: RouteMap
- Default value options: RouterOptions = { path: {} }
Returns ServerRouter

Properties

app

app: any

logger

logger: LoggerInstance

options

options: RouterOptions

routes

routes: any

Methods

bindMethod

bindMethod(method: any, routes: any): boolean

- Defined in components/router/router.ts:151
Binds all routes registered in the method supplied

Parameters
- method: any
  
  The http method to bind
- routes: any
  
  The routes map
Returns boolean

decoratedRoutes

decoratedRoutes(controllers: any): object

- Defined in components/router/router.ts:105
Prepare the decorated routes for being merged into the routes map.

Parameters
- controllers: any
  
  The controllers map
Returns object
- delete: object
- get: object
- post: object
- put: object

init

init(): void

- Defined in components/router/router.ts:138
Returns void

prepareControllerMethods

prepareControllerMethods(method: string, ctrl: BaseController): object

- Defined in components/router/router.ts:79
Prepare the controller methods to being bound.

Parameters
- method: string
- ctrl: BaseController
Returns object

register

register(app?: express.Application): any

- Defined in components/router/router.ts:227
Binds the controller to the express application or creates a new one.

Parameters
- Optional app: express.Application
Returns any

registerController

registerController(routes: any, r: any): any

- Defined in components/router/router.ts:188
Register the controller defined by the route supplied.

Parameters
- routes: any
  
  The routes map
- r: any
  
  The route to register
Returns any

Static build

build(controllers: any | string, routes: RouteMap | string, options?: RouterOptions): any

- Defined in components/router/router.ts:250
Build a router using the supplied routes map and options.

Parameters
- controllers: any | string
  
  The map of controller classes to bind to
- routes: RouteMap | string
  
  The map of route files ot bind to
- Optional options: RouterOptions
Returns any