@linkedmink/multilevel-aging-cache/dist/src/cache/IAgingCache.d.ts

Package provides an interface to cache and persist data to Redis, MongoDB, memory

/**
 * Describes what happened during a write to an aging cache
 */
export declare enum AgingCacheWriteStatus {
    /**
     * All caches were written successfully
     */
    Success = 0,
    /**
     * Lower level caches were updated from a newer value in a higher level cache
     */
    Refreshed = 1,
    /**
     * A higher level cache had a value update, but a write failed to a lower level cache
     */
    RefreshedError = 2,
    /**
     * Higher level caches were updated, but a lower level cache failed
     */
    PartialWrite = 3,
    /**
     * An error occured while writing
     */
    UnspecifiedError = 4
}
export interface IAgingCacheWrite<TValue> {
    status: AgingCacheWriteStatus;
    value?: TValue;
}
export declare type KeyValueArray<TKey, TValue> = [{
    key: TKey;
    val: TValue;
}];
/**
 * Represents a cache the has a replacement policy. Note that age is not necessarily
 * tied to time.
 */
export interface IAgingCache<TKey, TValue> {
    /**
     * @param key The key to retrieve
     * @param force If true force read from the top level instead of lower levels first
     * @returns The value if it's in the cache or null
     */
    get(key: TKey, force?: boolean): Promise<TValue | null>;
    /**
     * TODO Optionally return the set value since some layers may modify the object (MongoDB)
     * @param key The key to set
     * @param value The value to set
     * @param force If true write to all levels of hierarchy unconditionally
     * @returns If the write succeeded or the error condition
     */
    set(key: TKey, value: TValue, force?: boolean): Promise<IAgingCacheWrite<TValue>>;
    /**
     * @param key The key to the value to delete
     * @param force If true write to all levels of hierarchy unconditionally
     * @returns If the write succeeded or the error condition
     */
    delete(key: TKey, force?: boolean): Promise<IAgingCacheWrite<TValue>>;
    /**
     * @returns The keys that are currently in the cache
     */
    keys(): Promise<TKey[]>;
    /**
     * @param key The key to the value to clear from cache layers
     * @param force If true write to levels below the persistence layer
     * @returns If the write succeeded or the error condition
     */
    clear(key: TKey, force?: boolean): Promise<IAgingCacheWrite<TValue>>;
    /**
     * @returns The next value that's set to expire
     */
    peek(): Promise<TValue | null>;
    /**
     * TODO shield entry of actual data into cache
     * TODO Add method to get/set/delete/clear multiple keys to more efficiently load cache
     */
    load(keyValues: KeyValueArray<TKey, TValue>): Promise<number>;
    /**
     * Purge the cache of stale entries instead of waiting for a periodic check
     * @return A promise to track when the purge finishes
     */
    purge(): Promise<void>;
}
//# sourceMappingURL=IAgingCache.d.ts.map