ClusterRouterOptions
Defined in: src/cluster/router/ClusterRouter.ts:66
Type Parameters
Section titled “Type Parameters”TMsg
Properties
Section titled “Properties”cluster
Section titled “cluster”
readonlycluster:Cluster
Defined in: src/cluster/router/ClusterRouter.ts:68
The cluster the router lives in. Used for membership + transport.
extractKey?
Section titled “extractKey?”
readonlyoptionalextractKey?: (message) =>string
Defined in: src/cluster/router/ClusterRouter.ts:86
Required for routerType: 'consistent-hashing', ignored otherwise.
Returns the string key used to pin a message to a routee. Two
messages with the same key always land on the same node (subject
to the cluster topology not changing).
Parameters
Section titled “Parameters”message
Section titled “message”TMsg
Returns
Section titled “Returns”string
readonlyoptionalrole?:string
Defined in: src/cluster/router/ClusterRouter.ts:70
Restrict routees to up-members carrying this role. Omit for “any node”.
routeePath
Section titled “routeePath”
readonlyrouteePath:string
Defined in: src/cluster/router/ClusterRouter.ts:79
The path the routee actor lives under on each routee node — usually
/user/<actorName>. The same path must exist on every targeted
node; the router doesn’t probe for liveness beyond the cluster
membership state.
routerType
Section titled “routerType”
readonlyrouterType:ClusterRouterType
Defined in: src/cluster/router/ClusterRouter.ts:72
Strategy. See ClusterRouterType.