ShardedDaemonProcessOptionsBuilder
Defined in: src/cluster/sharding/ShardedDaemonProcessOptions.ts:32
Fluent builder for ShardedDaemonProcessOptionsType. The
actorFor factory is a whole-object field passed via a single
withActorFor(actorFor).
Extends
Section titled “Extends”Type Parameters
Section titled “Type Parameters”T
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ShardedDaemonProcessOptionsBuilder<
T>():ShardedDaemonProcessOptionsBuilder<T>
Returns
Section titled “Returns”ShardedDaemonProcessOptionsBuilder<T>
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”build()
Section titled “build()”build():
Partial<T>
Defined in: src/util/OptionsBuilder.ts:51
Snapshot the set fields as an independent Partial<T> (own props only).
Returns
Section titled “Returns”Partial<T>
Inherited from
Section titled “Inherited from”withActorFor()
Section titled “withActorFor()”withActorFor(
actorFor):this
Defined in: src/cluster/sharding/ShardedDaemonProcessOptions.ts:49
The daemon actor, chosen per index — gets the stable index (0..numDaemons-1).
Parameters
Section titled “Parameters”actorFor
Section titled “actorFor”(daemonIndex) => ActorClassOrFactory<T>
Returns
Section titled “Returns”this
withLivenessIntervalMs()
Section titled “withLivenessIntervalMs()”withLivenessIntervalMs(
livenessIntervalMs):this
Defined in: src/cluster/sharding/ShardedDaemonProcessOptions.ts:59
Period (ms) for the liveness ping that re-materializes daemons. Default: 30 s; 0 disables.
Parameters
Section titled “Parameters”livenessIntervalMs
Section titled “livenessIntervalMs”number
Returns
Section titled “Returns”this
withName()
Section titled “withName()”withName(
name):this
Defined in: src/cluster/sharding/ShardedDaemonProcessOptions.ts:39
Logical name used for the shard type; must be unique per daemon set.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”this
withNumDaemons()
Section titled “withNumDaemons()”withNumDaemons(
numDaemons):this
Defined in: src/cluster/sharding/ShardedDaemonProcessOptions.ts:44
Total number of daemons to keep running cluster-wide.
Parameters
Section titled “Parameters”numDaemons
Section titled “numDaemons”number
Returns
Section titled “Returns”this
withRole()
Section titled “withRole()”withRole(
role):this
Defined in: src/cluster/sharding/ShardedDaemonProcessOptions.ts:54
Only members carrying this role host daemons.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”this
create()
Section titled “create()”
staticcreate<T>():ShardedDaemonProcessOptionsBuilder<T>
Defined in: src/cluster/sharding/ShardedDaemonProcessOptions.ts:34
Start a fresh builder. Equivalent to new ShardedDaemonProcessOptionsBuilder<T>().
Type Parameters
Section titled “Type Parameters”T
Returns
Section titled “Returns”ShardedDaemonProcessOptionsBuilder<T>