AxEventRuntime

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

Constructors

Constructor

TypeScript

new AxEventRuntime(options: Readonly<AxEventRuntimeOptions>): AxEventRuntime;

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

Parameters

Parameter	Type
`options`	`Readonly`<`AxEventRuntimeOptions`>

Returns

AxEventRuntime

Properties

Property	Modifier	Type
`id`	`readonly`	`string`

Methods

cancelRun()

TypeScript

cancelRun(runId: string, reason: string): boolean;

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

Parameters

Parameter	Type	Default value
`runId`	`string`	`undefined`
`reason`	`string`	`'Cancelled by caller'`

Returns

boolean

close()

TypeScript

close(options: Readonly<AxEventCloseOptions>): Promise<void>;

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

Parameters

Parameter	Type
`options`	`Readonly`<`AxEventCloseOptions`>

Returns

Promise<void>

getRun()

TypeScript

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

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

Parameters

Parameter	Type
`runId`	`string`

Returns

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

listDeadLetters()

TypeScript

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

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

Returns

Promise<readonly Readonly<AxEventDeadLetter>[]>

publish()

TypeScript

publish(ingress: Readonly<AxEventIngress>, signal?: AbortSignal): Promise<AxEventPublishReceipt>;

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

Parameters

Parameter	Type
`ingress`	`Readonly`<`AxEventIngress`>
`signal?`	`AbortSignal`

Returns

Promise<AxEventPublishReceipt>

redrive()

TypeScript

redrive(deadLetterId: string): Promise<void>;

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

Parameters

Parameter	Type
`deadLetterId`	`string`

Returns

Promise<void>

start()

TypeScript

start(): Promise<void>;

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

Returns

Promise<void>

waitForIdle()

TypeScript

waitForIdle(timeoutMs: number): Promise<void>;

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

Parameters

Parameter	Type	Default value
`timeoutMs`	`number`	`30_000`

Returns

Promise<void>