kinetex - v1.0.0-rc.1
    Preparing search index...

    Interface CacheStorageAdapter

    Pluggable storage backend for cache entries.

    interface CacheStorageAdapter {
        get(key: string): Promise<CacheEntry | null>;
        set(key: string, entry: CacheEntry): Promise<boolean | void>;
        delete(key: string): Promise<void>;
        keys(): Promise<string[]>;
        clear(): Promise<void>;
    }

    Implemented by

    Index

    Methods

    • Retrieve an entry by key. Returns null when missing or expired.

      Parameters

      • key: string

      Returns Promise<CacheEntry | null>

    • Store an entry. May return false if storage was rejected (e.g. quota exceeded).

      Parameters

      Returns Promise<boolean | void>

    • Remove an entry by key.

      Parameters

      • key: string

      Returns Promise<void>

    • List all stored keys.

      Returns Promise<string[]>

    • Remove all entries.

      Returns Promise<void>