@solomonai/cache/dist/interface-D4FnSgmS.d.ts

<div align="center"> <h1 align="center">@solomonai/cache</h1> <h5>Cache all the things</h5> </div>

import { BaseError, Result } from '@unkey/error';

declare class CacheError extends BaseError {
    readonly name = "CacheError";
    readonly retry = false;
    readonly tier: string;
    readonly key: string;
    constructor(opts: {
        tier: string;
        key: string;
        message: string;
    });
}

type Entry<TValue> = {
    value: TValue;
    freshUntil: number;
    /**
     * Unix timestamp in milliseconds.
     *
     * Do not use data after this point as it is considered no longer valid.
     *
     * You can use this field to configure automatic eviction in your store implementation.   *
     */
    staleUntil: number;
};
/**
 * A store is a common interface for storing, reading and deleting key-value pairs.
 *
 * The store implementation is responsible for cleaning up expired data on its own.
 */
interface Store<TNamespace extends string, TValue> {
    /**
     * A name for metrics/tracing.
     *
     * @example: memory | zone
     */
    name: string;
    /**
     * Return the cached value
     *
     * The response must be `undefined` for cache misses
     */
    get(namespace: TNamespace, key: string): Promise<Result<Entry<TValue> | undefined, CacheError>>;
    /**
     * Sets the value for the given key.
     *
     * You are responsible for evicting expired values in your store implementation.
     * Use the `entry.staleUntil` (unix milli timestamp) field to configure expiration
     */
    set(namespace: TNamespace, key: string, value: Entry<TValue>): Promise<Result<void, CacheError>>;
    /**
     * Removes the key from the store.
     */
    remove(namespace: TNamespace, key: string | string[]): Promise<Result<void, CacheError>>;
}

export { CacheError as C, type Entry as E, type Store as S };