RedisStreamsOptionsBuilder
Defined in: src/io/broker/RedisStreamsOptions.ts:32
Extends
Section titled “Extends”BrokerOptionsBuilder<RedisStreamsOptionsType>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new RedisStreamsOptionsBuilder():
RedisStreamsOptionsBuilder
Returns
Section titled “Returns”RedisStreamsOptionsBuilder
Inherited from
Section titled “Inherited from”BrokerOptionsBuilder<RedisStreamsOptionsType>.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
withBlockMs()
Section titled “withBlockMs()”withBlockMs(
ms):this
Defined in: src/io/broker/RedisStreamsOptions.ts:54
Block timeout per XREADGROUP call in ms. Default 5000.
Parameters
Section titled “Parameters”number
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
withConsumerGroup()
Section titled “withConsumerGroup()”withConsumerGroup(
group):this
Defined in: src/io/broker/RedisStreamsOptions.ts:49
Consumer-group options — required to consume.
Parameters
Section titled “Parameters”consumer
Section titled “consumer”string
createIfMissing?
Section titled “createIfMissing?”boolean
Auto-create the group if missing. Default: true.
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
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
withStreams()
Section titled “withStreams()”withStreams(
streams):this
Defined in: src/io/broker/RedisStreamsOptions.ts:44
Streams to consume.
Parameters
Section titled “Parameters”streams
Section titled “streams”readonly string[]
Returns
Section titled “Returns”this
withTarget()
Section titled “withTarget()”withTarget(
target):this
Defined in: src/io/broker/RedisStreamsOptions.ts:59
Subscriber for inbound entries. Required to consume.
Parameters
Section titled “Parameters”target
Section titled “target”Returns
Section titled “Returns”this
withUrl()
Section titled “withUrl()”withUrl(
url):this
Defined in: src/io/broker/RedisStreamsOptions.ts:39
Redis URL ('redis://host:6379').
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”this
create()
Section titled “create()”
staticcreate():RedisStreamsOptionsBuilder
Defined in: src/io/broker/RedisStreamsOptions.ts:34
Start a fresh builder. Equivalent to new RedisStreamsOptionsBuilder().
Returns
Section titled “Returns”RedisStreamsOptionsBuilder