deprecated: use storage FIXME: remove this on 1.8
Doesn't attempt to create the KV stream if it doesn't exist.
An encoder/decoder for keys and values
Optional compressionSets the compression level of the KV. This feature is only supported in servers 2.10.x and better.
Sets the specified description on the stream of the KV.
Number of maximum messages allowed per subject (key).
use max_bytes
The maximum size of a value on the KV
The maximum number of bytes on the KV
Optional metadataMetadata 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.
Optional mirrorMaintains a 1:1 mirror of another kv stream with name matching this property.
Placement hints for the stream hosting the KV
@deprecated: use placement
Number of replicas for the KV (1,3,or 5).
Republishes edits to the KV on a NATS core subject.
Optional sourcesList of Stream names to replicate into this KV
The backing store of the stream hosting the KV
The underlying stream name for the KV
How long to wait in milliseconds for a response from the KV
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
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.