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

AxEventStore

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

Properties

PropertyModifierType
capabilitiesreadonlyReadonly<AxEventStoreCapabilities>

Methods

addDeadLetter()

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

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

Parameters

ParameterType
deadLetterReadonly<AxEventDeadLetter>

Returns

Promise<void>


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/types.ts#L507

Parameters

ParameterType
workerIdstring
nownumber
leaseMs?number

Returns

Promise<undefined | AxEventDelivery>


close()?

TypeScript
optional close(): void | Promise<void>;

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

Returns

void | Promise<void>


completeContinuation()

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

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

Parameters

ParameterType
idstring

Returns

Promise<void>


enqueue()

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

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

Parameters

ParameterType
requestReadonly<AxEventEnqueueRequest>
signal?AbortSignal

Returns

Promise<AxEventPublishReceipt>


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/types.ts#L527

Parameters

ParameterType
identityScopestring
correlationReadonly<AxEventCorrelationKey>
nownumber

Returns

Promise< | undefined | Readonly<AxEventContinuation>>


getDeadLetter()

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

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

Parameters

ParameterType
idstring

Returns

Promise< | undefined | Readonly<AxEventDeadLetter>>


getDelivery()

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

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

Parameters

ParameterType
deliveryIdstring

Returns

Promise< | undefined | Readonly<AxEventDelivery>>


getRun()

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

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

Parameters

ParameterType
runIdstring

Returns

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


isIdle()

TypeScript
isIdle(): Promise<boolean>;

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

Returns

Promise<boolean>


listDeadLetters()

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

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

Returns

Promise<readonly Readonly<AxEventDeadLetter>[]>


nextAvailableAt()

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

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

Parameters

ParameterType
nownumber

Returns

Promise<undefined | number>


redriveDelivery()

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

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

Parameters

ParameterType
deliveryIdstring
nownumber

Returns

Promise<void>


registerContinuation()

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

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

Parameters

ParameterType
continuationReadonly<AxEventContinuation>

Returns

Promise<void>


removeDeadLetter()

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

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

Parameters

ParameterType
idstring

Returns

Promise<void>


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/types.ts#L512

Parameters

ParameterType
deliveryIdstring
workerIdstring
fencingTokennumber
leaseExpiresAtnumber

Returns

Promise<void>


saveDelivery()

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

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

Parameters

ParameterType
deliveryReadonly<AxEventDelivery>

Returns

Promise<void>


saveRun()

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

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

Parameters

ParameterType
runReadonly<AxEventRun>

Returns

Promise<void>


waitForWork()

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

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

Parameters

ParameterType
signal?AbortSignal

Returns

Promise<void>

Docs