Class HttpRouterRegistry

Hierarchy

HttpRouterRegistryFunctionRegistrar
- HttpRouterRegistry

Index

Constructors

constructor

new HttpRouterRegistry(): HttpRouterRegistry
Returns HttpRouterRegistry

Inherited from HttpRouterRegistryFunctionRegistrar.constructor

Properties

`Protected` defaultOptions

defaultOptions: Partial<HttpRouterFunctionOptions> = {}

`Protected` routes

routes: RouteConfig[] = []

Methods

add

add(decorator: HttpDecorator, callback: ((...args: any[]) => any)): void
Parameters
- decorator: HttpDecorator
- callback: ((...args: any[]) => any)
  - - (...args: any[]): any
    - Parameters
      
      Rest ...args: any[]
      
      Returns any
Returns void
Inherited from HttpRouterRegistryFunctionRegistrar.add
- Defined in packages/http/src/router.ts:465

addRoute

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

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:593

any

any(pathOrOptions: string | HttpRouterFunctionOptions, callback: ((...args: any[]) => any)): void
Parameters
- pathOrOptions: string | HttpRouterFunctionOptions
- callback: ((...args: any[]) => any)
  - - (...args: any[]): any
    - Parameters
      
      Rest ...args: any[]
      
      Returns any
Returns void
Inherited from HttpRouterRegistryFunctionRegistrar.any
- Defined in packages/http/src/router.ts:461

delete

delete(pathOrOptions: string | HttpRouterFunctionOptions, callback: ((...args: any[]) => any)): void
Parameters
- pathOrOptions: string | HttpRouterFunctionOptions
- callback: ((...args: any[]) => any)
  - - (...args: any[]): any
    - Parameters
      
      Rest ...args: any[]
      
      Returns any
Returns void
Inherited from HttpRouterRegistryFunctionRegistrar.delete
- Defined in packages/http/src/router.ts:495

forOptions

forOptions(options: Partial<HttpRouterFunctionOptions>): HttpRouterRegistryFunctionRegistrar
Returns a new registrar object with default options that apply to each registered route through this registrar.
```
const registry: HttpRouterRegistry = ...;

const secretRegistry = registry.forOptions({groups: ['secret']});

secretRegistry.get('/admin/groups', () => {
});

secretRegistry.get('/admin/users', () => {
});
```
Parameters
- options: Partial<HttpRouterFunctionOptions>
Returns HttpRouterRegistryFunctionRegistrar
Inherited from HttpRouterRegistryFunctionRegistrar.forOptions
- Defined in packages/http/src/router.ts:450

get

get(pathOrOptions: string | HttpRouterFunctionOptions, callback: ((...args: any[]) => any)): void
Parameters
- pathOrOptions: string | HttpRouterFunctionOptions
- callback: ((...args: any[]) => any)
  - - (...args: any[]): any
    - Parameters
      
      Rest ...args: any[]
      
      Returns any
Returns void
Inherited from HttpRouterRegistryFunctionRegistrar.get
- Defined in packages/http/src/router.ts:479

getBuildId

getBuildId(): number
Returns number
- Defined in packages/http/src/router.ts:585

getRoutes

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

head

head(pathOrOptions: string | HttpRouterFunctionOptions, callback: ((...args: any[]) => any)): void
Parameters
- pathOrOptions: string | HttpRouterFunctionOptions
- callback: ((...args: any[]) => any)
  - - (...args: any[]): any
    - Parameters
      
      Rest ...args: any[]
      
      Returns any
Returns void
Inherited from HttpRouterRegistryFunctionRegistrar.head
- Defined in packages/http/src/router.ts:507

options

options(pathOrOptions: string | HttpRouterFunctionOptions, callback: ((...args: any[]) => any)): void
Parameters
- pathOrOptions: string | HttpRouterFunctionOptions
- callback: ((...args: any[]) => any)
  - - (...args: any[]): any
    - Parameters
      
      Rest ...args: any[]
      
      Returns any
Returns void
Inherited from HttpRouterRegistryFunctionRegistrar.options
- Defined in packages/http/src/router.ts:499

patch

patch(pathOrOptions: string | HttpRouterFunctionOptions, callback: ((...args: any[]) => any)): void
Parameters
- pathOrOptions: string | HttpRouterFunctionOptions
- callback: ((...args: any[]) => any)
  - - (...args: any[]): any
    - Parameters
      
      Rest ...args: any[]
      
      Returns any
Returns void
Inherited from HttpRouterRegistryFunctionRegistrar.patch
- Defined in packages/http/src/router.ts:491

post

post(pathOrOptions: string | HttpRouterFunctionOptions, callback: ((...args: any[]) => any)): void
Parameters
- pathOrOptions: string | HttpRouterFunctionOptions
- callback: ((...args: any[]) => any)
  - - (...args: any[]): any
    - Parameters
      
      Rest ...args: any[]
      
      Returns any
Returns void
Inherited from HttpRouterRegistryFunctionRegistrar.post
- Defined in packages/http/src/router.ts:483

put

put(pathOrOptions: string | HttpRouterFunctionOptions, callback: ((...args: any[]) => any)): void
Parameters
- pathOrOptions: string | HttpRouterFunctionOptions
- callback: ((...args: any[]) => any)
  - - (...args: any[]): any
    - Parameters
      
      Rest ...args: any[]
      
      Returns any
Returns void
Inherited from HttpRouterRegistryFunctionRegistrar.put
- Defined in packages/http/src/router.ts:487

trace

trace(pathOrOptions: string | HttpRouterFunctionOptions, callback: ((...args: any[]) => any)): void
Parameters
- pathOrOptions: string | HttpRouterFunctionOptions
- callback: ((...args: any[]) => any)
  - - (...args: any[]): any
    - Parameters
      
      Rest ...args: any[]
      
      Returns any
Returns void
Inherited from HttpRouterRegistryFunctionRegistrar.trace
- Defined in packages/http/src/router.ts:503

Class HttpRouterRegistry

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns HttpRouterRegistry

Properties

Protected defaultOptions

Protected routes

Methods

add

Parameters

decorator: HttpDecorator

callback: ((...args: any[]) => any)

Parameters

Rest ...args: any[]

Returns any

Returns void

addRoute

Parameters

routeConfig: RouteConfig

Returns void

addRouteForController

Parameters

controller: ClassType<any>

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

Returns void

any

Parameters

pathOrOptions: string | HttpRouterFunctionOptions

callback: ((...args: any[]) => any)

Parameters

Rest ...args: any[]

Returns any

Returns void

delete

Parameters

pathOrOptions: string | HttpRouterFunctionOptions

callback: ((...args: any[]) => any)

Parameters

Rest ...args: any[]

Returns any

Returns void

forOptions

Parameters

options: Partial<HttpRouterFunctionOptions>

Returns HttpRouterRegistryFunctionRegistrar

get

Parameters

pathOrOptions: string | HttpRouterFunctionOptions

callback: ((...args: any[]) => any)

Parameters

Rest ...args: any[]

Returns any

Returns void

getBuildId

Returns number

getRoutes

Returns RouteConfig[]

head

Parameters

pathOrOptions: string | HttpRouterFunctionOptions

callback: ((...args: any[]) => any)

Parameters

Rest ...args: any[]

Returns any

Returns void

options

Parameters

pathOrOptions: string | HttpRouterFunctionOptions

callback: ((...args: any[]) => any)

Parameters

Rest ...args: any[]

Returns any

Returns void

patch

Parameters

`Protected` defaultOptions

`Protected` routes

`Rest` ...args: any[]

`Rest` ...args: any[]

`Rest` ...args: any[]

`Rest` ...args: any[]

`Rest` ...args: any[]

`Rest` ...args: any[]

`Rest` ...args: any[]

`Rest` ...args: any[]

`Rest` ...args: any[]

`Rest` ...args: any[]