AxContextCacheRegistry Generated TypeScript API reference. typescript api api/reference build/apidocs/TypeAlias.AxContextCacheRegistry.md type AxContextCacheRegistry

AxContextCacheRegistry

TypeScript
type AxContextCacheRegistry = object;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/types.ts#L730

External registry for persisting context cache metadata. Useful for serverless/short-lived processes where in-memory storage is lost.

Example

TypeScript
// Redis-backed registry
const registry: AxContextCacheRegistry = {
  get: async (key) => {
    const data = await redis.get(`cache:${key}`);
    return data ? JSON.parse(data) : undefined;
  },
  set: async (key, entry) => {
    await redis.set(`cache:${key}`, JSON.stringify(entry), 'EX', 3600);
  },
};

Properties

get()

TypeScript
get: (key: string) => 
  | Promise<
  | AxContextCacheRegistryEntry
  | undefined>
  | AxContextCacheRegistryEntry
  | undefined;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/types.ts#L732

Look up a cache entry by key

Parameters

ParameterType
keystring

Returns

| Promise< | AxContextCacheRegistryEntry | undefined> | AxContextCacheRegistryEntry | undefined


set()

TypeScript
set: (key: string, entry: Readonly<AxContextCacheRegistryEntry>) => Promise<void> | void;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/types.ts#L739

Store a cache entry

Parameters

ParameterType
keystring
entryReadonly<AxContextCacheRegistryEntry>

Returns

Promise<void> | void

Docs