Interface KvOptions



allow_direct: boolean

If true and on a recent server, changes the way the KV retrieves values. This option is significantly faster, but has the possibility of inconsistency during a read.

backingStore: StorageType

deprecated: use storage FIXME: remove this on 1.8

bindOnly: boolean

Doesn't attempt to create the KV stream if it doesn't exist.

codec: KvCodecs

An encoder/decoder for keys and values

compression?: boolean

Sets the compression level of the KV. This feature is only supported in servers 2.10.x and better.

description: string

Sets the specified description on the stream of the KV.

history: number

Number of maximum messages allowed per subject (key).

maxBucketSize: number


use max_bytes

maxValueSize: number

The maximum size of a value on the KV

max_bytes: number

The maximum number of bytes on the KV

metadata?: Record<string, string>

Metadata field to store additional information about the kv. Note that keys starting with _nats are reserved. This feature only supported on servers 2.10.x and better.

mirror?: StreamSource

Maintains a 1:1 mirror of another kv stream with name matching this property.

placement: Placement

Placement hints for the stream hosting the KV

placementCluster: string

@deprecated: use placement

replicas: number

Number of replicas for the KV (1,3,or 5).

republish: Republish

Republishes edits to the KV on a NATS core subject.

sources?: StreamSource[]

List of Stream names to replicate into this KV

storage: StorageType

The backing store of the stream hosting the KV

streamName: string

The underlying stream name for the KV

timeout: number

How long to wait in milliseconds for a response from the KV

ttl: number

The maximum number of millis the key should live in the KV. The server will automatically remove keys older than this amount. Note that deletion of delete markers are not performed.

Generated using TypeDoc