Class HttpRouter

Hierarchy

HttpRouter

Index

Constructors

Properties

Methods

addRoute addRouteForController build buildUrlResolver getRouteCode getRouteUrlResolveCode getRoutes resolve resolveRequest resolveUrl forControllers

Constructors

constructor

new HttpRouter(controllers: HttpControllers, logger: LoggerInterface, tagRegistry: TagRegistry, middlewareRegistry?: MiddlewareRegistry, registry?: HttpRouterRegistry): HttpRouter
Parameters
- controllers: HttpControllers
- logger: LoggerInterface
- tagRegistry: TagRegistry
- middlewareRegistry: MiddlewareRegistry = ...
- registry: HttpRouterRegistry = ...
Returns HttpRouter
- Defined in packages/http/src/router.ts:655

Properties

`Protected` buildId

buildId: number = 0

`Protected` `Optional` fn

fn?: ((request: HttpRequest) => undefined | ResolvedController)

Type declaration

- (request: HttpRequest): undefined | ResolvedController
- Parameters
  - request: HttpRequest
  Returns undefined | ResolvedController

`Protected` `Optional` resolveFn

resolveFn?: ((name: string, parameters: {
[name: string]: any;
}) => string)

Type declaration

- (name: string, parameters: {
  [name: string]: any;
  }): string
- Parameters
  - name: string
  - parameters: {
    [name: string]: any;
    }
    - [name: string]: any
  Returns string

Methods

addRoute

addRoute(routeConfig: RouteConfig): void
Parameters
- routeConfig: RouteConfig
Returns void
- Defined in packages/http/src/router.ts:911

addRouteForController

addRouteForController(controller: ClassType<any>, module: InjectorModule<any, InjectorModule<any, any>>): void
Parameters
- controller: ClassType<any>
- module: InjectorModule<any, InjectorModule<any, any>>
Returns void
- Defined in packages/http/src/router.ts:915

`Protected` build

build(): ((request: HttpRequest) => undefined | ResolvedController)
Returns ((request: HttpRequest) => undefined | ResolvedController)
- - (request: HttpRequest): undefined | ResolvedController
  - Parameters
    - request: HttpRequest
    Returns undefined | ResolvedController
- Defined in packages/http/src/router.ts:919

`Protected` buildUrlResolver

buildUrlResolver(): any
Returns any
- Defined in packages/http/src/router.ts:943

`Protected` getRouteCode

getRouteCode(compiler: CompilerContext, routeConfig: RouteConfig): string
Parameters
- compiler: CompilerContext
- routeConfig: RouteConfig
Returns string
- Defined in packages/http/src/router.ts:682

`Protected` getRouteUrlResolveCode

getRouteUrlResolveCode(compiler: CompilerContext, routeConfig: RouteConfig): string
Parameters
- compiler: CompilerContext
- routeConfig: RouteConfig
Returns string
- Defined in packages/http/src/router.ts:875

getRoutes

getRoutes(): RouteConfig[]
Returns RouteConfig[]
- Defined in packages/http/src/router.ts:667

resolve

resolve(method: string, url: string): undefined | ResolvedController
Parameters
- method: string
- url: string
Returns undefined | ResolvedController
- Defined in packages/http/src/router.ts:975

resolveRequest

resolveRequest(request: HttpRequest): undefined | ResolvedController
Parameters
- request: HttpRequest
Returns undefined | ResolvedController
- Defined in packages/http/src/router.ts:967

resolveUrl

resolveUrl(routeName: string, parameters?: {
[name: string]: any;
}): string
Parameters
- routeName: string
- parameters: {
  [name: string]: any;
  } = {}
  - [name: string]: any
Returns string
- Defined in packages/http/src/router.ts:959

`Static` forControllers

forControllers(controllers: (ClassType<any> | {
controller: ClassType<any>;
module: InjectorModule<any, InjectorModule<any, any>>;
})[], tagRegistry?: TagRegistry, middlewareRegistry?: MiddlewareRegistry, module?: InjectorModule<any, InjectorModule<any, any>>): HttpRouter
Parameters
- controllers: (ClassType<any> | {
  controller: ClassType<any>;
  module: InjectorModule<any, InjectorModule<any, any>>;
  })[]
- tagRegistry: TagRegistry = ...
- middlewareRegistry: MiddlewareRegistry = ...
- module: InjectorModule<any, InjectorModule<any, any>> = ...
Returns HttpRouter
- Defined in packages/http/src/router.ts:671

Class HttpRouter

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

controllers: HttpControllers

logger: LoggerInterface

tagRegistry: TagRegistry

middlewareRegistry: MiddlewareRegistry = ...

registry: HttpRouterRegistry = ...

Returns HttpRouter

Properties

Protected buildId

Protected Optional fn

Type declaration

Parameters

request: HttpRequest

Returns undefined | ResolvedController

Protected Optional resolveFn

Type declaration

Parameters

name: string

parameters: { [name: string]: any; }

[name: string]: any

Returns string

Methods

addRoute

Parameters

routeConfig: RouteConfig

Returns void

addRouteForController

Parameters

controller: ClassType<any>

module: InjectorModule<any, InjectorModule<any, any>>

Returns void

Protected build

Returns ((request: HttpRequest) => undefined | ResolvedController)

Parameters

request: HttpRequest

Returns undefined | ResolvedController

Protected buildUrlResolver

Returns any

Protected getRouteCode

Parameters

compiler: CompilerContext

routeConfig: RouteConfig

Returns string

Protected getRouteUrlResolveCode

Parameters

compiler: CompilerContext

routeConfig: RouteConfig

Returns string

getRoutes

Returns RouteConfig[]

resolve

Parameters

method: string

url: string

Returns undefined | ResolvedController

resolveRequest

Parameters

request: HttpRequest

Returns undefined | ResolvedController

resolveUrl

Parameters

routeName: string

parameters: { [name: string]: any; } = {}

[name: string]: any

Returns string

Static forControllers

Parameters

controllers: (ClassType<any> | { controller: ClassType<any>; module: InjectorModule<any, InjectorModule<any, any>>; })[]

tagRegistry: TagRegistry = ...

middlewareRegistry: MiddlewareRegistry = ...

module: InjectorModule<any, InjectorModule<any, any>> = ...

Returns HttpRouter

`Protected` buildId

`Protected` `Optional` fn

`Protected` `Optional` resolveFn

parameters: {
[name: string]: any;
}

`Protected` build

`Protected` buildUrlResolver

`Protected` getRouteCode

`Protected` getRouteUrlResolveCode

parameters: {
[name: string]: any;
} = {}

`Static` forControllers

controllers: (ClassType<any> | {
controller: ClassType<any>;
module: InjectorModule<any, InjectorModule<any, any>>;
})[]