AxInMemoryEventStore Generated TypeScript API reference. typescript api api/reference build/apidocs/Class.AxInMemoryEventStore.md class AxInMemoryEventStore

AxInMemoryEventStore

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

Implements

Constructors

Constructor

TypeScript
new AxInMemoryEventStore(options: Readonly<AxInMemoryEventStoreOptions>): AxInMemoryEventStore;

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

Parameters

ParameterType
optionsReadonly<AxInMemoryEventStoreOptions>

Returns

AxInMemoryEventStore

Properties

PropertyModifierType
capabilitiesreadonlyobject
capabilities.compareAndSetreadonlyfalse
capabilities.coordinationreadonly"single-worker"
capabilities.durabilityreadonly"volatile"
capabilities.leasesreadonlyfalse
capabilities.outputPersistencereadonlytrue
capabilities.transactionsreadonlyfalse

Methods

addDeadLetter()

TypeScript
addDeadLetter(deadLetter: Readonly<AxEventDeadLetter>): Promise<void>;

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

Parameters

ParameterType
deadLetterReadonly<AxEventDeadLetter>

Returns

Promise<void>

Implementation of

AxEventStore.addDeadLetter


claim()

TypeScript
claim(
   workerId: string, 
   now: number, 
leaseMs: number): Promise<undefined | AxEventDelivery>;

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

Parameters

ParameterTypeDefault value
workerIdstringundefined
nownumberundefined
leaseMsnumber30_000

Returns

Promise<undefined | AxEventDelivery>

Implementation of

AxEventStore.claim


close()

TypeScript
close(): Promise<void>;

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

Returns

Promise<void>

Implementation of

AxEventStore.close


completeContinuation()

TypeScript
completeContinuation(id: string): Promise<void>;

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

Parameters

ParameterType
idstring

Returns

Promise<void>

Implementation of

AxEventStore.completeContinuation


enqueue()

TypeScript
enqueue(request: Readonly<AxEventEnqueueRequest>, signal?: AbortSignal): Promise<AxEventPublishReceipt>;

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

Parameters

ParameterType
requestReadonly<AxEventEnqueueRequest>
signal?AbortSignal

Returns

Promise<AxEventPublishReceipt>

Implementation of

AxEventStore.enqueue


findContinuation()

TypeScript
findContinuation(
   identityScope: string, 
   correlation: Readonly<AxEventCorrelationKey>, 
   now: number): Promise<
  | undefined
| Readonly<AxEventContinuation>>;

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

Parameters

ParameterType
identityScopestring
correlationReadonly<AxEventCorrelationKey>
nownumber

Returns

Promise< | undefined | Readonly<AxEventContinuation>>

Implementation of

AxEventStore.findContinuation


getDeadLetter()

TypeScript
getDeadLetter(id: string): Promise<
  | undefined
| Readonly<AxEventDeadLetter>>;

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

Parameters

ParameterType
idstring

Returns

Promise< | undefined | Readonly<AxEventDeadLetter>>

Implementation of

AxEventStore.getDeadLetter


getDelivery()

TypeScript
getDelivery(deliveryId: string): Promise<
  | undefined
| Readonly<AxEventDelivery>>;

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

Parameters

ParameterType
deliveryIdstring

Returns

Promise< | undefined | Readonly<AxEventDelivery>>

Implementation of

AxEventStore.getDelivery


getRun()

TypeScript
getRun(runId: string): Promise<
  | undefined
| Readonly<AxEventRun<unknown>>>;

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

Parameters

ParameterType
runIdstring

Returns

Promise< | undefined | Readonly<AxEventRun<unknown>>>

Implementation of

AxEventStore.getRun


isIdle()

TypeScript
isIdle(): Promise<boolean>;

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

Returns

Promise<boolean>

Implementation of

AxEventStore.isIdle


listDeadLetters()

TypeScript
listDeadLetters(): Promise<readonly Readonly<AxEventDeadLetter>[]>;

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

Returns

Promise<readonly Readonly<AxEventDeadLetter>[]>

Implementation of

AxEventStore.listDeadLetters


nextAvailableAt()

TypeScript
nextAvailableAt(_now: number): Promise<undefined | number>;

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

Parameters

ParameterType
_nownumber

Returns

Promise<undefined | number>

Implementation of

AxEventStore.nextAvailableAt


redriveDelivery()

TypeScript
redriveDelivery(deliveryId: string, now: number): Promise<void>;

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

Parameters

ParameterType
deliveryIdstring
nownumber

Returns

Promise<void>

Implementation of

AxEventStore.redriveDelivery


registerContinuation()

TypeScript
registerContinuation(continuation: Readonly<AxEventContinuation>): Promise<void>;

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

Parameters

ParameterType
continuationReadonly<AxEventContinuation>

Returns

Promise<void>

Implementation of

AxEventStore.registerContinuation


removeDeadLetter()

TypeScript
removeDeadLetter(id: string): Promise<void>;

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

Parameters

ParameterType
idstring

Returns

Promise<void>

Implementation of

AxEventStore.removeDeadLetter


renewClaim()

TypeScript
renewClaim(
   deliveryId: string, 
   workerId: string, 
   fencingToken: number, 
leaseExpiresAt: number): Promise<void>;

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

Parameters

ParameterType
deliveryIdstring
workerIdstring
fencingTokennumber
leaseExpiresAtnumber

Returns

Promise<void>

Implementation of

AxEventStore.renewClaim


saveDelivery()

TypeScript
saveDelivery(delivery: Readonly<AxEventDelivery>): Promise<void>;

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

Parameters

ParameterType
deliveryReadonly<AxEventDelivery>

Returns

Promise<void>

Implementation of

AxEventStore.saveDelivery


saveRun()

TypeScript
saveRun(run: Readonly<AxEventRun>): Promise<void>;

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

Parameters

ParameterType
runReadonly<AxEventRun>

Returns

Promise<void>

Implementation of

AxEventStore.saveRun


waitForWork()

TypeScript
waitForWork(signal?: AbortSignal): Promise<void>;

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

Parameters

ParameterType
signal?AbortSignal

Returns

Promise<void>

Implementation of

AxEventStore.waitForWork

Docs