NatsOptionsBuilder
此内容尚不支持你的语言。
Defined in: src/io/broker/NatsOptions.ts:27
Extends
Section titled “Extends”BrokerOptionsBuilder<NatsOptionsType>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new NatsOptionsBuilder():
NatsOptionsBuilder
Returns
Section titled “Returns”NatsOptionsBuilder
Inherited from
Section titled “Inherited from”BrokerOptionsBuilder<NatsOptionsType>.constructor
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”BrokerOptionsBuilder.build
withCircuitBreaker()
Section titled “withCircuitBreaker()”withCircuitBreaker(
failureThreshold,resetMs):this
Defined in: src/io/broker/BrokerOptions.ts:125
Circuit breaker around connect attempts.
Parameters
Section titled “Parameters”failureThreshold
Section titled “failureThreshold”number
resetMs
Section titled “resetMs”number
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”BrokerOptionsBuilder.withCircuitBreaker
withName()
Section titled “withName()”withName(
name):this
Defined in: src/io/broker/NatsOptions.ts:59
Client name reported to the server.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”this
withOutboundBuffer()
Section titled “withOutboundBuffer()”withOutboundBuffer(
limit):this
Defined in: src/io/broker/BrokerOptions.ts:130
Outbound buffer size (messages held while disconnected). Default 1000; 0 = fail-fast.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”BrokerOptionsBuilder.withOutboundBuffer
withPassword()
Section titled “withPassword()”withPassword(
password):this
Defined in: src/io/broker/NatsOptions.ts:49
Password credential.
Parameters
Section titled “Parameters”password
Section titled “password”string
Returns
Section titled “Returns”this
withReconnect()
Section titled “withReconnect()”withReconnect(
policy):this
Defined in: src/io/broker/BrokerOptions.ts:120
Reconnect policy (or false to disable auto-reconnect).
Parameters
Section titled “Parameters”policy
Section titled “policy”false | { factor?: number; initialDelayMs?: number; maxAttempts?: number; maxDelayMs?: number; } | undefined
false
Type Literal
Section titled “Type Literal”{ factor?: number; initialDelayMs?: number; maxAttempts?: number; maxDelayMs?: number; }
factor?
Section titled “factor?”number
initialDelayMs?
Section titled “initialDelayMs?”number
maxAttempts?
Section titled “maxAttempts?”number
Cap on retry attempts. Default: Infinity (retry forever).
maxDelayMs?
Section titled “maxDelayMs?”number
undefined
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”BrokerOptionsBuilder.withReconnect
withServers()
Section titled “withServers()”withServers(
servers):this
Defined in: src/io/broker/NatsOptions.ts:34
NATS server URLs ('nats://localhost:4222' or array).
Parameters
Section titled “Parameters”servers
Section titled “servers”string | readonly string[]
Returns
Section titled “Returns”this
withSubscriptions()
Section titled “withSubscriptions()”withSubscriptions(
subscriptions):this
Defined in: src/io/broker/NatsOptions.ts:54
Subscriptions wired up at connect time.
Parameters
Section titled “Parameters”subscriptions
Section titled “subscriptions”readonly object[]
Returns
Section titled “Returns”this
withToken()
Section titled “withToken()”withToken(
token):this
Defined in: src/io/broker/NatsOptions.ts:39
Token credential.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”this
withUser()
Section titled “withUser()”withUser(
user):this
Defined in: src/io/broker/NatsOptions.ts:44
Username credential.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”this
create()
Section titled “create()”
staticcreate():NatsOptionsBuilder
Defined in: src/io/broker/NatsOptions.ts:29
Start a fresh builder. Equivalent to new NatsOptionsBuilder().
Returns
Section titled “Returns”NatsOptionsBuilder