Skip to main content

RouterParameters

@webda/core

Class: RouterParameters

Defined in: packages/core/src/rest/router.service.ts:164

Parameters for the Router service

Extends​

Constructors​

Constructor​

new RouterParameters(): RouterParameters

Returns​

RouterParameters

Inherited from​

ServiceParameters.constructor

Properties​

aliases?​

optional aliases?: Record<string, string | RouteAliasDefinition>

Defined in: packages/core/src/rest/router.service.ts:173

Route aliases: key is the alias URL template, value the target

Example​

{ "/me": "/users/${user.id}" }

overrideWarning?​

optional overrideWarning?: boolean

Defined in: packages/core/src/rest/router.service.ts:168

Display a WARNING if a route is overriden

type​

type: string

Defined in: packages/core/src/services/serviceparameters.ts:10

Type of the service

Inherited from​

ServiceParameters.type

Methods​

load()​

load(params?): this

Defined in: packages/core/src/rest/router.service.ts:180

Load parameters and normalize aliases

Parameters​

params?​

any = {}

service parameters to load

Returns​

this

this for chaining

Overrides​

ServiceParameters.load

update()​

update(params?, delta): this

Defined in: packages/core/src/application/parameters.ts:33

Update parameters and call watchers if a parameter was changed

Parameters​

params?​

any = {}

the service parameters

delta​

any

the delta

Returns​

this

this for chaining

Inherited from​

ServiceParameters.update

with()​

with(callback): this

Defined in: packages/core/src/application/parameters.ts:63

Watch for changes on the parameters and call watchers when a parameter is changed

Parameters​

callback​

(params) => void

the callback function

Returns​

this

this for chaining

Inherited from​

ServiceParameters.with