Skip to main content

ConfigurationServiceParameters

@webda/core

Class: ConfigurationServiceParameters

Defined in: packages/core/src/configurations/configuration.service.ts:32

Parameters for the ConfigurationService, defining how configuration sources are loaded and refreshed

Extends​

Extended by​

Constructors​

Constructor​

new ConfigurationServiceParameters(): ConfigurationServiceParameters

Returns​

ConfigurationServiceParameters

Inherited from​

ServiceParameters.constructor

Properties​

checkInterval​

checkInterval: Duration

Defined in: packages/core/src/configurations/configuration.service.ts:37

Check configuration every {checkInterval} seconds

Default​

1h

default?​

optional default?: any

Defined in: packages/core/src/configurations/configuration.service.ts:58

Default configuration to use

Default​

{ services: {}, parameters: {} }

source​

source: string

Defined in: packages/core/src/configurations/configuration.service.ts:48

Format sourceServiceName:sourceId or sourceId if source is this service

sources​

sources: string[]

Defined in: packages/core/src/configurations/configuration.service.ts:53

List of sources to load and merge ( in order ) Format sourceServiceName:sourceId or sourceId if source is this service

type​

type: string

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

Type of the service

Inherited from​

ServiceParameters.type

Accessors​

checkIntervalMs​

Get Signature​

get checkIntervalMs(): number

Defined in: packages/core/src/configurations/configuration.service.ts:42

Check interval in ms

Returns​

number

the result

Methods​

load()​

load(params): ConfigurationServiceParameters

Defined in: packages/core/src/configurations/configuration.service.ts:65

Load and apply defaults to configuration parameters

Parameters​

params​

any

the service parameters

Returns​

ConfigurationServiceParameters

the result

Overrides​

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