createPersistentCache()

Defined in: cache.ts:271

Creates a cached version of an async function with memory and/or persistent caching capabilities.

Features:Copy Anchor Link

• Prevents redundant computations across sessions or concurrent calls
• Shares results between tabs or plugins (Pass external cache object to share in-memory cache across plugins)
• Supports in-memory, IndexedDB, or both as cache targets
• Optional parallel execution of cache read and function compute
• Useful for data generation, API fetches, or any expensive computation

ParametersCopy Anchor Link

Type ParametersCopy Anchor Link

TArgsCopy Anchor Link

TArgs extends unknown[]

TResultCopy Anchor Link

TResult

ParametersCopy Anchor Link

generatorCopy Anchor Link

(...args) => Promise<TResult>

The async function to cache (e.g., a fetcher or processor)

namespaceCopy Anchor Link

string

A tag used to group related cached entries for cleanup or metrics

config?Copy Anchor Link

CacheConfigType<TResult>

Optional configuration:

• ignoreKeys (string[]) — Keys to exclude from cache key generation (default: [])
• cache (Record<string, Promise<Result>>) — External in-memory cache object to sync across plugins/tabs (default: internal default cache)
• cacheMode ("memory" | "idb" | "both") — Where to store the result:
  • "memory": RAM-only; fast but temporary
  • "idb": stores in IndexedDB only; avoids memory usage; Useful for processing large data
  • "both" (default): caches in both RAM and IndexedDB
• parallel (boolean) — If true, reads from cache and computes in parallel (default: true); ignored when cacheMode is "memory"

ReturnsCopy Anchor Link

A memoized async function that handles caching automatically.

(...args) => Promise<TResult>

ExampleCopy Anchor Link

const fetchWithCache = createPersistentCache(fetchJson, "remote-data");
await fetchWithCache("https://example.com/api/data");