Skip to main content

RouterParameters

@webda/core

Class: RouterParameters

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

Parameters for the Router service

Extends​

Constructors​

Constructor​

new RouterParameters(): RouterParameters

Returns​

RouterParameters

Inherited from​

ServiceParameters.constructor

Properties​

overrideWarning?​

optional overrideWarning?: boolean

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

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/services/serviceparameters.ts:24

Load raw parameters by assigning them onto this instance

Parameters​

params?​

any = {}

the service parameters

Returns​

this

this for chaining

Inherited from​

ServiceParameters.load

update()​

update(params?, delta): this

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

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/services/serviceparameters.ts:65

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