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/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/event/types.ts#L514

Properties

PropertyModifierType
capabilitiesreadonlyReadonly<AxEventStoreCapabilities>

Methods

addDeadLetter()

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

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/event/types.ts#L546

Parameters

ParameterType
deadLetterReadonly<AxEventDeadLetter>

Returns

Promise<void>


claim()

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

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/event/types.ts#L520

Parameters

ParameterType
workerIdstring
nownumber
leaseMs?number

Returns

Promise<AxEventDelivery | undefined>


close()?

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

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/event/types.ts#L554

Returns

void | Promise<void>


completeContinuation()

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

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/event/types.ts#L545

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/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/event/types.ts#L516

Parameters

ParameterType
requestReadonly<AxEventEnqueueRequest>
signal?AbortSignal

Returns

Promise<AxEventPublishReceipt>


findContinuation()

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

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

Parameters

ParameterType
identityScopestring
correlationReadonly<AxEventCorrelationKey>
nownumber

Returns

Promise< | Readonly<AxEventContinuation> | undefined>


getDeadLetter()

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

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/event/types.ts#L547

Parameters

ParameterType
idstring

Returns

Promise< | Readonly<AxEventDeadLetter> | undefined>


getDelivery()

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

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/event/types.ts#L531

Parameters

ParameterType
deliveryIdstring

Returns

Promise< | Readonly<AxEventDelivery> | undefined>


getRun()

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

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

Parameters

ParameterType
runIdstring

Returns

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


isIdle()

TypeScript
isIdle(): Promise<boolean>;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/event/types.ts#L553

Returns

Promise<boolean>


listDeadLetters()

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

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/event/types.ts#L549

Returns

Promise<readonly Readonly<AxEventDeadLetter>[]>


nextAvailableAt()

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

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/event/types.ts#L551

Parameters

ParameterType
nownumber

Returns

Promise<number | undefined>


redriveDelivery()

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

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/event/types.ts#L550

Parameters

ParameterType
deliveryIdstring
nownumber

Returns

Promise<void>


registerContinuation()

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

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

Parameters

ParameterType
continuationReadonly<AxEventContinuation>

Returns

Promise<void>


removeDeadLetter()

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

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/event/types.ts#L548

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/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/event/types.ts#L525

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/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/event/types.ts#L534

Parameters

ParameterType
deliveryReadonly<AxEventDelivery>

Returns

Promise<void>


saveRun()

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

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

Parameters

ParameterType
runReadonly<AxEventRun>

Returns

Promise<void>


waitForWork()

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

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/event/types.ts#L552

Parameters

ParameterType
signal?AbortSignal

Returns

Promise<void>

Docs