Class Router

Responsible to hold middleware functions and routes.

Hierarchy

Router

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Router(basePath: string): Router

- Defined in src/Router.ts:27
Instanciates a new router.

Parameters
- basePath: string
  
  Router base path that is common to all routes.
Returns Router

Properties

Private _basePath

_basePath: string

Router's base path that is common to all routes that belong to this router.

Private _queue

_queue: Array<RequestDelegate>

Router's execution queue that contains all functions that are run when handle method is called.

Private _routes

_routes: Array<Route>

Array of routes that belong to this router.

Accessors

basePath

get basePath(): string

- Defined in src/Router.ts:92
Returns string

queue

get queue(): RequestDelegate[]

- Defined in src/Router.ts:96
Returns RequestDelegate[]

Methods

handle

handle(req: Request, res: Response): Promise<void>

- Defined in src/Router.ts:80
Executes router execution queue.

Parameters
- req: Request
  
  http request.
- res: Response
  
  http response.
Returns Promise<void>

match

match(path: string, method: string): undefined | Route

- Defined in src/Router.ts:65
Returns the route that matches requested path and method, otherwise undefined.

Parameters
- path: string
  
  requested path.
- method: string
  
  requested method.
Returns undefined | Route

use

use(v: RequestDelegate): void

- Defined in src/Router.ts:43
Adds a function to the router execution queue.

Parameters
- v: RequestDelegate
  
  function that is going to be added.
Returns void

useRoutes

useRoutes(routes: Route[]): void

- Defined in src/Router.ts:52
Adds an array of routes to the router and updates routes path based on router base path.

Parameters
- routes: Route[]
  
  routes that are going to be added.
Returns void

Generated using TypeDoc