DistributedPubSubOptionsBuilder
Defined in: src/cluster/pubsub/DistributedPubSubOptions.ts:43
Fluent builder for DistributedPubSubOptionsType. The mediator is normally spawned by the DistributedPubSub extension, which injects the cluster and forwards the operator’s tuning choices.
Extends
Section titled “Extends”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new DistributedPubSubOptionsBuilder():
DistributedPubSubOptionsBuilder
Returns
Section titled “Returns”DistributedPubSubOptionsBuilder
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”withCluster()
Section titled “withCluster()”withCluster(
cluster):this
Defined in: src/cluster/pubsub/DistributedPubSubOptions.ts:50
The cluster this mediator lives in — drives membership + gossip peers.
Parameters
Section titled “Parameters”cluster
Section titled “cluster”Returns
Section titled “Returns”this
withGossipIntervalMs()
Section titled “withGossipIntervalMs()”withGossipIntervalMs(
ms):this
Defined in: src/cluster/pubsub/DistributedPubSubOptions.ts:55
Gossip interval in ms between anti-entropy pushes. Default gossip interval.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”this
withMaxRemoteNodesPerTopic()
Section titled “withMaxRemoteNodesPerTopic()”withMaxRemoteNodesPerTopic(
maxRemoteNodesPerTopic):this
Defined in: src/cluster/pubsub/DistributedPubSubOptions.ts:70
Cap on the remote nodes that may claim subscribers for one topic.
Parameters
Section titled “Parameters”maxRemoteNodesPerTopic
Section titled “maxRemoteNodesPerTopic”number
Returns
Section titled “Returns”this
withMaxSubscribersPerTopic()
Section titled “withMaxSubscribersPerTopic()”withMaxSubscribersPerTopic(
maxSubscribersPerTopic):this
Defined in: src/cluster/pubsub/DistributedPubSubOptions.ts:60
Cap on the local subscribers a single topic may hold.
Parameters
Section titled “Parameters”maxSubscribersPerTopic
Section titled “maxSubscribersPerTopic”number
Returns
Section titled “Returns”this
withMaxTopics()
Section titled “withMaxTopics()”withMaxTopics(
maxTopics):this
Defined in: src/cluster/pubsub/DistributedPubSubOptions.ts:65
Cap on the distinct topics this mediator tracks.
Parameters
Section titled “Parameters”maxTopics
Section titled “maxTopics”number
Returns
Section titled “Returns”this
withSendToDeadLettersWhenNoSubscribers()
Section titled “withSendToDeadLettersWhenNoSubscribers()”withSendToDeadLettersWhenNoSubscribers(
sendToDeadLettersWhenNoSubscribers):this
Defined in: src/cluster/pubsub/DistributedPubSubOptions.ts:75
Send a publish that reached no subscriber to system.deadLetters.
Parameters
Section titled “Parameters”sendToDeadLettersWhenNoSubscribers
Section titled “sendToDeadLettersWhenNoSubscribers”boolean
Returns
Section titled “Returns”this
create()
Section titled “create()”
staticcreate():DistributedPubSubOptionsBuilder
Defined in: src/cluster/pubsub/DistributedPubSubOptions.ts:45
Start a fresh builder.
Returns
Section titled “Returns”DistributedPubSubOptionsBuilder