JetStreamKeyValueOptionsType

Ce contenu n’est pas encore disponible dans votre langue.

Defined in: src/io/broker/JetStreamKeyValueOptions.ts:17

Common options every broker actor accepts on top of its protocol- specific options. Subclasses extend this interface with their own required fields (e.g. brokerUrl, topics).

Extends

BrokerCommonOptionsType

Properties

bucket?

readonly optional bucket?: string

Defined in: src/io/broker/JetStreamKeyValueOptions.ts:27

Bucket this actor operates on — required.

circuitBreaker?

readonly optional circuitBreaker?: object

Defined in: src/io/broker/BrokerOptions.ts:48

Optional circuit-breaker around connectImplementation. After failureThreshold consecutive failed connect attempts the breaker opens for resetMs and rejects new attempts immediately.

failureThreshold

readonly failureThreshold: number

resetMs

readonly resetMs: number

Inherited from

BrokerCommonOptionsType.circuitBreaker

create?

readonly optional create?: boolean

Defined in: src/io/broker/JetStreamKeyValueOptions.ts:51

Create the bucket at connect time when it does not exist. Default true. false binds to an existing bucket and fails the connect if it is missing — the right setting when the bucket is provisioned by an operator and a typo should not silently create an empty one.

history?

readonly optional history?: number

Defined in: src/io/broker/JetStreamKeyValueOptions.ts:33

Revisions kept per key. 1 (the JetStream default) keeps only the current value; a higher history is what makes compare-and-swap and watch replay useful. Only applied when the actor creates the bucket.

maxValueBytes?

readonly optional maxValueBytes?: number

Defined in: src/io/broker/JetStreamKeyValueOptions.ts:44

Server-side cap on a single value, in bytes. Only applied on create.

name?

readonly optional name?: string

Defined in: src/io/broker/JetStreamKeyValueOptions.ts:25

Optional client name.

outboundBuffer?

readonly optional outboundBuffer?: number

Defined in: src/io/broker/BrokerOptions.ts:61

Maximum number of outbound messages buffered while the connection is connecting or disconnected. When the buffer is full the oldest message is dropped (FIFO eviction) and a BrokerBufferOverflow event is published. Default: 1000. Set to 0 to fail-fast (publish a BrokerNotConnected event and drop the message).

Inherited from

BrokerCommonOptionsType.outboundBuffer

password?

readonly optional password?: string

Defined in: src/io/broker/JetStreamKeyValueOptions.ts:23

reconnect?

readonly optional reconnect?: false | { factor?: number; initialDelayMs?: number; maxAttempts?: number; maxDelayMs?: number; }

Defined in: src/io/broker/BrokerOptions.ts:35

Reconnect strategy applied when the underlying connection drops or connectImplementation throws. Default: exponential backoff starting at 200ms, doubling, capped at 30s, infinite attempts. Set to false to disable auto-reconnect (one-shot connections).