Interface Route

Route contains information to adding/registering new route with the router. Method+Path pair uniquely identifies the Route. It is mandatory to provide Method+Path+Handler fields.

Hierarchy

Route

Index

Methods

forGroup toRoute toRouteInfo

Properties

handler method middlewares name path

Methods

forGroup

forGroup(pathPrefix, middlewares): Routable
ForGroup recreates Route with added group prefix and group middlewares it is grouped to.
Parameters
- pathPrefix: string
- middlewares: MiddlewareFunc[]
Returns Routable
- Defined in types.d.ts:19267

toRoute

toRoute(): Route
ToRoute returns Route which Router uses to register the method handler for path.

Returns Route
- Defined in types.d.ts:19261

toRouteInfo

toRouteInfo(params): RouteInfo
ToRouteInfo converts Route to RouteInfo
Parameters
- params: string[]
Returns RouteInfo
- Defined in types.d.ts:19255

Properties

handler

handler: HandlerFunc

method

method: string

middlewares

middlewares: MiddlewareFunc[]

name

name: string

path

path: string

Generated using TypeDoc