AmqpOptionsBuilder
Defined in: src/io/broker/AmqpOptions.ts:24
Extends
Section titled “Extends”BrokerOptionsBuilder<AmqpOptionsType>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new AmqpOptionsBuilder():
AmqpOptionsBuilder
Returns
Section titled “Returns”AmqpOptionsBuilder
Inherited from
Section titled “Inherited from”BrokerOptionsBuilder<AmqpOptionsType>.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
withAutoAcknowledge()
Section titled “withAutoAcknowledge()”withAutoAcknowledge(
on?):this
Defined in: src/io/broker/AmqpOptions.ts:46
Auto-ack consumed deliveries. Default true.
Parameters
Section titled “Parameters”boolean = true
Returns
Section titled “Returns”this
withBindings()
Section titled “withBindings()”withBindings(
bindings):this
Defined in: src/io/broker/AmqpOptions.ts:41
Queues + bindings + targets to set up after connect.
Parameters
Section titled “Parameters”bindings
Section titled “bindings”readonly AmqpQueueBinding[]
Returns
Section titled “Returns”this
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
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
withPrefetch()
Section titled “withPrefetch()”withPrefetch(
count):this
Defined in: src/io/broker/AmqpOptions.ts:36
Unacked messages a consumer holds at once. Default 1.
Parameters
Section titled “Parameters”number
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
withUrl()
Section titled “withUrl()”withUrl(
url):this
Defined in: src/io/broker/AmqpOptions.ts:31
AMQP URL (amqp://user:pass@host:5672/vhost).
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”this
create()
Section titled “create()”
staticcreate():AmqpOptionsBuilder
Defined in: src/io/broker/AmqpOptions.ts:26
Start a fresh builder. Equivalent to new AmqpOptionsBuilder().
Returns
Section titled “Returns”AmqpOptionsBuilder