@joshdb/cache

@joshdb/cache

An auto ensure middleware for Josh.

Description

A cache middleware for Josh.

Features

• Written in TypeScript
• Offers CommonJS, ESM and UMD bundles
• Fully tested

Installation

You can use the following command to install this package, or replace npm install with your package manager of choice.

npm install @joshdb/cache

Middleware Context Data

interface ContextData<StoredValue = unknown> {
  /**
   * The JoshProvider to use for cache
   * @since 1.0.0
   */
  provider: JoshProvider<Document<StoredValue>>;

  /**
   * When true, fetches all entries from the provider on startup
   * @since 1.0.0
   * @default true
   */
  fetchAll: boolean;

  /**
   * When enabled fetches from the cache provider on a set interval
   * @since 1.0.0
   */
  polling?: PollingOptions;

  /**
   * When enabled invalidates entries from the cache provider when they expire
   * @since 1.0.0
   */
  ttl?: TTLOptions;
}