@nats-io/kv
    Preparing search index...

    Type Alias KvStatus

    KvStatus: KvLimits & {
        bucket: string;
        markerTTL: number;
        metadata?: Record<string, string>;
        size: number;
        streamInfo: StreamInfo;
        values: number;
    }

    Type declaration

    • bucket: string

      The simple name for a Kv - this name is typically prefixed by KV_.

    • markerTTL: number

      Number of millis delete markers will live before they are removed by the server. Note that this value will be set to 0 if the underlying stream doesn't enable this feature. This is a feature that must be configured on bucket creation.

    • Optionalmetadata?: Record<string, string>

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

    • size: number

      Size of the bucket in bytes

    • streamInfo: StreamInfo

      The StreamInfo backing up the KV

    • values: number

      Number of entries in the KV

    Settings

    Member Visibility