Implementing a Store

Implement a custom cache store for @unkey/cache by following the Store interface. Build adapters for Redis, DynamoDB, or any backend you need.

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.

You can build your own store by implementing the following interface:

Store

/**
 * 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.
 */
export interface Store<TNamespace extends string, TValue> {
  /**
   * A name for metrics/tracing.
   *
   * @example: memory
   */
  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 one or multiple keys from the store.
   */
  remove(
    namespace: TNamespace,
    keys: string | string[],
  ): Promise<Result<void, CacheError>>;
}

Entry

export type Entry<TValue> = {
  value: TValue;

  // Before this time the entry is considered fresh and valid
  // UnixMilli
  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;
};