import Routes from 'pop-api/src/middleware/Routes.js'

public class | source

Routes

Class for setting up the Routes.

Test:

Routes

Constructor Summary

Public Constructor
public	constructor(PopApi: PopApi, options: Object) Create a new Routes object.

Method Summary

Public Methods
public	convertErrors(err: Error, req: IncomingMessage, res: ServerResponse, next: Function): ApiError Convert the thrown errors to an instance of ApiError.
public	postRoutes(app: Express): undefined Hook method for setting up middleware post setting up the routes.
public	preRoutes(app: Express): undefined Hook method for setting up middleware pre setting up the routes.
public	registerControllers(app: Express, PopApi: PopApi, controllers: Array<Object>): undefined Register the controllers found in the controllers directory.
public	removeServerHeader(req: IncomingMessage, res: ServerResponse, next: Function): undefined Remove security sensitive headers.
public	setErrorHandler(err: ApiError, req: IncomingMessage, res: ServerResponse, next: Function): Object Error handler middleware
public	setNotFoundHandler(req: IncomingMessage, res: ServerResponse, next: Function): ApiError Catch the 404 errors.
public	setupRoutes(app: Express, PopApi: PopApi, controllers: Array<Object>): undefined Setup the application service.

Public Constructors

public constructor(PopApi: PopApi, options: Object) source

Create a new Routes object.

Params:

Name	Type	Attribute	Description
PopApi	PopApi	nullable: false	The PopApi instance to bind the routes to.
options	Object	nullable: false	The options for the routes.
options.app	Express	nullable: false	The application instance to add middleware and bind the routes to.
options.controllers	Array<Object>	nullable: true	The controllers to register.

Throw:

TypeError

'app' are required options for the routes middleware!

Test:

Routes should register the routes when creating a new Routes object

Public Methods

public convertErrors(err: Error, req: IncomingMessage, res: ServerResponse, next: Function): ApiError source

Convert the thrown errors to an instance of ApiError.

Params:

Name	Type	Attribute	Description
err	Error	nullable: false	The caught error.
req	IncomingMessage	nullable: false	The incoming message request object.
res	ServerResponse	nullable: false	The server response object.
next	Function	nullable: false	The next function to move to the next middleware.

Return:

ApiError

The converted error.

Test:

Routes should catch a 500 internal server error with a default error

public postRoutes(app: Express): undefined source

Hook method for setting up middleware post setting up the routes.

Params:

Name	Type	Attribute	Description
app	Express	nullable: false	The application instance to add middleware to.

Return:

undefined

Test:

Routes should execute the post routes hook

public preRoutes(app: Express): undefined source

Hook method for setting up middleware pre setting up the routes.

Params:

Name	Type	Attribute	Description
app	Express	nullable: false	The application instance to add middleware to.

Return:

undefined

Test:

public registerControllers(app: Express, PopApi: PopApi, controllers: Array<Object>): undefined source

Params:

Name	Type	Attribute	Description
app	Express	nullable: false	The application instance to register the routers to.
PopApi	PopApi	nullable: false	The PopApi instance to bind the routes to.
controllers	Array<Object>	nullable: false	The controllers to register.

Return:

undefined

Test:

Routes should register a controller

public removeServerHeader(req: IncomingMessage, res: ServerResponse, next: Function): undefined source

Remove security sensitive headers.

Params:

Name	Type	Attribute	Description
req	IncomingMessage	nullable: false	The incoming message request object.
res	ServerResponse	nullable: false	The server response object.
next	Function	nullable: false	The next function to move to the next middleware.

public setErrorHandler(err: ApiError, req: IncomingMessage, res: ServerResponse, next: Function): Object source

Error handler middleware

Params:

Name	Type	Attribute	Description
err	ApiError	nullable: false	The caught error.
req	IncomingMessage	nullable: false	The incoming message request object.
res	ServerResponse	nullable: false	The server response object.
next	Function	nullable: false	The next function to move to the next middleware.

Return:

Object

The error object.

Test:

Routes should catch a 500 internal server error with a custom error

public setNotFoundHandler(req: IncomingMessage, res: ServerResponse, next: Function): ApiError source

Catch the 404 errors.

Params:

Name	Type	Attribute	Description
req	IncomingMessage	nullable: false	The incoming message request object.
res	ServerResponse	nullable: false	The server response object.
next	Function	nullable: false	The next function to move to the next middleware.

Return:

ApiError

A standard 404 error.

Test:

Routes should catch a 404 not found error

public setupRoutes(app: Express, PopApi: PopApi, controllers: Array<Object>): undefined source

Setup the application service.

Params:

Name	Type	Attribute	Description
app	Express	nullable: false	The application instance to add middleware and bind the routes to.
PopApi	PopApi	nullable: false	The PopApi instance to bind the routes to.
controllers	Array<Object>	optional nullable: true	The controllers to register.

Return:

undefined

Routes

Test:

Constructor Summary

Method Summary

Public Constructors

public constructor(PopApi: PopApi, options: Object) source

Params:

Throw:

Test:

Public Methods

public convertErrors(err: Error, req: IncomingMessage, res: ServerResponse, next: Function): ApiError source

Params:

Return:

Test:

public postRoutes(app: Express): undefined source

Params:

Return:

Test:

public preRoutes(app: Express): undefined source

Params:

Return:

Test:

public registerControllers(app: Express, PopApi: PopApi, controllers: Array<Object>): undefined source

Params:

Return:

Test:

public removeServerHeader(req: IncomingMessage, res: ServerResponse, next: Function): undefined source

Params:

Return:

Test:

See:

public setErrorHandler(err: ApiError, req: IncomingMessage, res: ServerResponse, next: Function): Object source

Params:

Return:

Test:

public setNotFoundHandler(req: IncomingMessage, res: ServerResponse, next: Function): ApiError source

Params:

Return:

Test:

public setupRoutes(app: Express, PopApi: PopApi, controllers: Array<Object>): undefined source

Params:

Return:

Test: