Class HttpRouterRegistryFunctionRegistrar`Abstract`

Hierarchy

HttpRouterRegistryFunctionRegistrar
- HttpRouterRegistry

Index

Constructors

constructor

new HttpRouterRegistryFunctionRegistrar(): HttpRouterRegistryFunctionRegistrar
Returns HttpRouterRegistryFunctionRegistrar

Properties

`Protected` defaultOptions

defaultOptions: Partial<HttpRouterFunctionOptions> = {}

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
- Defined in packages/http/src/router.ts:465

`Abstract` addRoute

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

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
- 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
- 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
- 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
- Defined in packages/http/src/router.ts:479

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
- 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
- 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
- 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
- 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
- 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
- Defined in packages/http/src/router.ts:503

Class HttpRouterRegistryFunctionRegistrarAbstract

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns HttpRouterRegistryFunctionRegistrar

Properties

Protected defaultOptions

Methods

add

Parameters

decorator: HttpDecorator

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

Parameters

Rest ...args: any[]

Returns any

Returns void

Abstract addRoute

Parameters

routeConfig: RouteConfig

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

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

pathOrOptions: string | HttpRouterFunctionOptions

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

Parameters

Rest ...args: any[]

Returns any

Returns void

post

Parameters

pathOrOptions: string | HttpRouterFunctionOptions

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

Class HttpRouterRegistryFunctionRegistrar`Abstract`

`Protected` defaultOptions

`Rest` ...args: any[]

`Abstract` addRoute

`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[]