Class Router

Manage Route resolution

Hierarchy

Router

Constructors

Properties

initiated

pathMap

routes

webda

Methods

addRoute

completeOpenAPI

getRouteFromUrl

getRouteMethodsFromUrl

Constructors

new Router(webda: Core): Router

Parameters
- webda: Core
Returns Router
- Defined in packages/core/src/router.ts:41

Properties

initiated: boolean = false

pathMap: object[]

routes: Map<string, RouteInfo[]> = new Map()

webda: Core

Methods

addRoute(url: string, info: RouteInfo): void

Add a route dynamicaly

Parameters
- url: string
  
  of the route can contains dynamic part like {uuid}
- info: RouteInfo
  
  the type of executor
Returns void
- Defined in packages/core/src/router.ts:52

comparePath(a: any, b: any): number

Parameters
- a: any
- b: any
Returns number
- Defined in packages/core/src/router.ts:99

completeOpenAPI(openapi: Document, skipHidden?: boolean): void

Add all known routes to paths

Parameters
- openapi: Document
  
  to complete
- Default value skipHidden: boolean = true
  
  add hidden routes or not
Returns void
- Defined in packages/core/src/router.ts:188

getRouteFromUrl(ctx: Context, method: HttpMethodType, url: string): any

Get the route from a method / url

Parameters
- ctx: Context
- method: HttpMethodType
- url: string
Returns any
- Defined in packages/core/src/router.ts:153

getRouteMethodsFromUrl(url: any): HttpMethodType[]

Get all method for a specific url

Parameters
- url: any
Returns HttpMethodType[]
- Defined in packages/core/src/router.ts:132

remapRoutes(): void

Returns void
- Defined in packages/core/src/router.ts:81

removeRoute(url: any): void

Remove a route dynamicly

Parameters
- url: any
  
  to remove
Returns void
- Defined in packages/core/src/router.ts:76

Generated using TypeDoc