Class Route

Responsible to hold information of a route.

Hierarchy

Route

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Route(path: string, method: string): Route

- Defined in src/Route.ts:33
Instanciates a new route.

Parameters
- path: string
  
  route's path
- method: string
  
  route's http method
Returns Route

Properties

Private _method

_method: string

Route's http method.

Private _params

_params: Array<string>

Route's path parameters

Private _path

_path: string

Route's path.

Private _queue

_queue: Array<RequestDelegate>

Route's execution queue.

matchedParams

matchedParams: any

Route's parameters resolved at doesMatch

Accessors

method

get method(): string

- Defined in src/Route.ts:112
Returns string

path

get path(): string
set path(p: string): void

- Defined in src/Route.ts:104
Returns string
- Defined in src/Route.ts:108
Parameters
- p: string
Returns void

queue

get queue(): RequestDelegate[]

- Defined in src/Route.ts:116
Returns RequestDelegate[]

Methods

handle

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

- Defined in src/Route.ts:61
Executes router execution queue.

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

match

match(path: string, method: string): boolean

- Defined in src/Route.ts:78
Checks if requested path and method match route's details.

Parameters
- path: string
  
  requested path
- method: string
  
  requested http method
Returns boolean

use

use(v: RequestDelegate): void

- Defined in src/Route.ts:52
Adds a function to the route execution queue.

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

Generated using TypeDoc