@japofc/baileys - v2.4.7
    Preparing search index...

    Interface KVStore

    KV store — tiny JSON key-value database with namespaces.

    interface KVStore {
        file: string | null;
        isDirty: boolean;
        size: number;
        all(): Record<string, unknown>;
        clear(): void;
        delete(key: string): boolean;
        entries(): [string, unknown][];
        flush(): Promise<void>;
        get<T = unknown>(key: string, fallback?: T): T;
        getOrSet<T>(
            key: string,
            factory: T | (() => T),
            options?: { ttlMs?: number },
        ): T;
        has(key: string): boolean;
        increment(key: string, by?: number): number;
        keys(): string[];
        namespace(ns: string): KVNamespace;
        set<T>(key: string, value: T, options?: { ttlMs?: number }): T;
    }

    Hierarchy (View Summary)

    Index
    file isDirty size
    all clear delete entries flush get getOrSet has increment keys namespace set
    file: string | null
    isDirty: boolean
    size: number

    • Write pending changes now (saves are debounced + atomic).

      Returns Promise<void>

    • Return the cached value or create-and-store it.

      Type Parameters

      • T

      Parameters

      • key: string
      • factory: T | (() => T)
      • Optionaloptions: { ttlMs?: number }

      Returns T

    • Type Parameters

      • T

      Parameters

      • key: string
      • value: T
      • Optionaloptions: { ttlMs?: number }

      Returns T

    Settings
    Member Visibility

    On This Page
    Properties
    Methods