Skip to content
actor-ts

ClusterSingletonManagerSettings

Defined in: src/cluster/singleton/ClusterSingletonManager.ts:41

Type Parameters

Section titled “Type Parameters”

T

Section titled “T”

T

Properties

Section titled “Properties”

acquireRetryIntervalMs?

Section titled “acquireRetryIntervalMs?”

readonly optional acquireRetryIntervalMs?: number

Defined in: src/cluster/singleton/ClusterSingletonManager.ts:52

Retry interval for lease.acquire() after a failed attempt. Default: 5 s.

cluster

Section titled “cluster”

readonly cluster: Cluster

Defined in: src/cluster/singleton/ClusterSingletonManager.ts:42

lease?

Section titled “lease?”

readonly optional lease?: Lease

Defined in: src/cluster/singleton/ClusterSingletonManager.ts:50

Optional split-brain protection — see StartSingletonSettings.lease.

role?

Section titled “role?”

readonly optional role?: string

Defined in: src/cluster/singleton/ClusterSingletonManager.ts:48

Optional role — only nodes with this role will host the singleton.

singletonProps

Section titled “singletonProps”

readonly singletonProps: Props<T>

Defined in: src/cluster/singleton/ClusterSingletonManager.ts:46

How to construct the singleton actor. Only instantiated on the leader.

typeName

Section titled “typeName”

readonly typeName: string

Defined in: src/cluster/singleton/ClusterSingletonManager.ts:44

Logical name for this singleton; also used as the child-actor name.