Skip to main content

ClusterServiceParameters

@webda/runtime


Class: ClusterServiceParameters

Defined in: packages/runtime/src/services/cluster.service.ts:52

Extends​

  • ServiceParameters

Constructors​

Constructor​

new ClusterServiceParameters(params?): ClusterServiceParameters

Defined in: packages/runtime/src/services/cluster.service.ts:82

Initialize cluster parameters with defaults

Parameters​

params?​

any

raw configuration values

Returns​

ClusterServiceParameters

Overrides​

ServiceParameters.constructor

Properties​

keepAlive​

keepAlive: number

Defined in: packages/runtime/src/services/cluster.service.ts:64

Default​

30000

pubsub​

pubsub: string

Defined in: packages/runtime/src/services/cluster.service.ts:56

Default​

PubSub

ttl​

ttl: number

Defined in: packages/runtime/src/services/cluster.service.ts:60

Default​

twice keepAlive

type​

type: string

Defined in: packages/core/lib/services/serviceparameters.d.ts:8

Type of the service

Inherited from​

ServiceParameters.type


unsyncCodeAlert?​

optional unsyncCodeAlert?: boolean

Defined in: packages/runtime/src/services/cluster.service.ts:76

Display code alert when code is out of sync

Can be disabled by setting it to false - in case different code is subscribing to the same pubsub

If undefined it will display the alert only once

true will force it to display every time

Param​

params

Methods​

load()​

load(params?): this

Defined in: packages/core/lib/services/serviceparameters.d.ts:18

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/lib/services/serviceparameters.d.ts:25

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/lib/services/serviceparameters.d.ts:31

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