Type Alias KvLimits

KvLimits: {
    compression?: boolean;
    description: string;
    history: number;
    max_bytes: number;
    maxValueSize: number;
    mirror?: StreamSource;
    placement: Placement;
    replicas: number;
    republish: Republish;
    sources?: StreamSource[];
    storage: StorageType;
    ttl: number;
}

Type declaration

  • Optionalcompression?: 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).

  • max_bytes: number

    The maximum number of bytes on the KV

  • maxValueSize: number

    The maximum size of a value on the KV

  • Optionalmirror?: 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

  • replicas: number

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

  • republish: Republish

    Republishes edits to the KV on a NATS core subject.

  • Optionalsources?: StreamSource[]

    List of Stream names to replicate into this KV

  • storage: StorageType

    The backing store of the stream hosting 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.