ClusterClientOptionsBuilder
此内容尚不支持你的语言。
Defined in: src/cluster/ClusterClientOptions.ts:41
Fluent builder for ClusterClientOptionsType:
new ClusterClient( ClusterClientOptions.create() .withContactPoints(['sys@127.0.0.1:2551']) .withAskTimeoutMs(3_000),);Extends
Section titled “Extends”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ClusterClientOptionsBuilder():
ClusterClientOptionsBuilder
Returns
Section titled “Returns”ClusterClientOptionsBuilder
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”withAskTimeoutMs()
Section titled “withAskTimeoutMs()”withAskTimeoutMs(
ms):this
Defined in: src/cluster/ClusterClientOptions.ts:63
Default ask timeout in ms. Default 5 s.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”this
withClientIdentity()
Section titled “withClientIdentity()”withClientIdentity(
host,port):this
Defined in: src/cluster/ClusterClientOptions.ts:58
Host + port the client claims as its identity for reply routing.
Parameters
Section titled “Parameters”string
number
Returns
Section titled “Returns”this
withContactPoints()
Section titled “withContactPoints()”withContactPoints(
contactPoints):this
Defined in: src/cluster/ClusterClientOptions.ts:48
Cluster nodes to dial (host:port or <system>@host:port). Tried in order.
Parameters
Section titled “Parameters”contactPoints
Section titled “contactPoints”readonly string[]
Returns
Section titled “Returns”this
withLogger()
Section titled “withLogger()”withLogger(
logger):this
Defined in: src/cluster/ClusterClientOptions.ts:73
Custom logger; default ConsoleLogger at WARN.
Parameters
Section titled “Parameters”logger
Section titled “logger”Returns
Section titled “Returns”this
withSystemName()
Section titled “withSystemName()”withSystemName(
systemName):this
Defined in: src/cluster/ClusterClientOptions.ts:53
Synthetic system name embedded in the client’s hello. Default cluster-client.
Parameters
Section titled “Parameters”systemName
Section titled “systemName”string
Returns
Section titled “Returns”this
withTls()
Section titled “withTls()”withTls(
tls):this
Defined in: src/cluster/ClusterClientOptions.ts:68
TLS config — must match the cluster’s.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”this
create()
Section titled “create()”
staticcreate():ClusterClientOptionsBuilder
Defined in: src/cluster/ClusterClientOptions.ts:43
Start a fresh builder. Equivalent to new ClusterClientOptionsBuilder().
Returns
Section titled “Returns”ClusterClientOptionsBuilder