ClusterSingletonManagerOptionsType

ClusterSingletonManagerOptionsType<T> = object

Plain options-object shape consumed by a ClusterSingletonManager.

Type Parameters

T

readonly optional acquireRetryIntervalMs?: number

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

readonly cluster: Cluster

readonly optional lease?: Lease

Optional split-brain protection — see StartSingletonOptionsType.lease.

readonly optional role?: string

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

readonly singletonActor: ActorClassOrFactory<T>

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

readonly optional singletonActorOptions?: ActorOptions<T>

readonly typeName: string

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