ShardedDaemonProcessOptionsType

ShardedDaemonProcessOptionsType<T> = object

Defined in: src/cluster/sharding/ShardedDaemonProcessOptions.ts:6

Plain options-object shape consumed by ShardedDaemonProcess.init.

Type Parameters

T

T

Properties

actorFor

readonly actorFor: (daemonIndex) => ActorClassOrFactory<T>

Defined in: src/cluster/sharding/ShardedDaemonProcessOptions.ts:12

The daemon actor, chosen per index — gets the stable index (0..numDaemons-1).

Parameters

daemonIndex

number

Returns

ActorClassOrFactory<T>

---

livenessIntervalMs?

readonly optional livenessIntervalMs?: number

Defined in: src/cluster/sharding/ShardedDaemonProcessOptions.ts:24

Period (ms) at which a “liveness ping” wakes every daemon index even when no cluster topology event has fired. Acts as a safety net for the event-driven path (LeaderChanged / MemberRemoved) — if a wake was missed (e.g. brief partition right at the failover moment), the heartbeat ensures the daemons still get re-materialized.

Default: 30_000 (30 s). Set to 0 to disable.

---

name

readonly name: string

Defined in: src/cluster/sharding/ShardedDaemonProcessOptions.ts:8

Logical name used for the shard type; must be unique per daemon set.

---

numDaemons

readonly numDaemons: number

Defined in: src/cluster/sharding/ShardedDaemonProcessOptions.ts:10

Total number of daemons to keep running cluster-wide.

---

role?

readonly optional role?: string

Defined in: src/cluster/sharding/ShardedDaemonProcessOptions.ts:14

Optional role — only members carrying the role host daemons.