AxProgramStateStore Generated TypeScript API reference. typescript api api/reference build/apidocs/Interface.AxProgramStateStore.md interface AxProgramStateStore

AxProgramStateStore

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/event/types.ts#L224

Methods

compareAndSet()

TypeScript
compareAndSet(
   key: string, 
   expectedRevision: undefined | number, 
   state: Readonly<Omit<AxProgramStateEnvelope, "revision">>, 
   fence?: Readonly<{
  deliveryId: string;
  fencingToken: number;
}>): Promise<Readonly<AxProgramStateEnvelope>>;

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/event/types.ts#L226

Parameters

ParameterType
keystring
expectedRevisionundefined | number
stateReadonly<Omit<AxProgramStateEnvelope, "revision">>
fence?Readonly<{ deliveryId: string; fencingToken: number; }>

Returns

Promise<Readonly<AxProgramStateEnvelope>>


delete()

TypeScript
delete(key: string): Promise<void>;

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/event/types.ts#L232

Parameters

ParameterType
keystring

Returns

Promise<void>


load()

TypeScript
load(key: string): Promise<
  | undefined
| Readonly<AxProgramStateEnvelope>>;

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/event/types.ts#L225

Parameters

ParameterType
keystring

Returns

Promise< | undefined | Readonly<AxProgramStateEnvelope>>

Docs