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

AxEventRouteBuilder

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

Constructors

Constructor

TypeScript
new AxEventRouteBuilder(id: string): AxEventRouteBuilder;

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

Parameters

ParameterType
idstring

Returns

AxEventRouteBuilder

Methods

authenticated()

TypeScript
authenticated(): this;

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

Returns

this


authorize()

TypeScript
authorize(authorize: (ingress: Readonly<AxEventIngress>) => boolean | Promise<boolean>): this;

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

Parameters

ParameterType
authorize(ingress: Readonly<AxEventIngress>) => boolean | Promise<boolean>

Returns

this


build()

TypeScript
build(): AxEventRoute;

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

Returns

AxEventRoute


correlate()

TypeScript
correlate(kind: string, selector: Readonly<AxEventPath>): this;

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

Parameters

ParameterType
kindstring
selectorReadonly<AxEventPath>

Returns

this


correlation()

TypeScript
correlation(correlation: (ingress: Readonly<AxEventIngress>) => 
  | undefined
  | Readonly<AxEventCorrelationKey>): this;

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

Parameters

ParameterType
correlation(ingress: Readonly<AxEventIngress>) => | undefined | Readonly<AxEventCorrelationKey>

Returns

this


debounce()

TypeScript
debounce(ms: number, options: Readonly<{
  coalesce?: "latest";
}>): this;

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

Parameters

ParameterType
msnumber
optionsReadonly<{ coalesce?: "latest"; }>

Returns

this


extensions()

TypeScript
extensions(extensions: Readonly<Record<string, AxEventScalar>>): this;

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

Parameters

ParameterType
extensionsReadonly<Record<string, AxEventScalar>>

Returns

this


instanceKey()

TypeScript
instanceKey(selector: 
  | Readonly<AxEventPath<unknown>>
  | (ingress: Readonly<AxEventIngress>) => string | Promise<string>): this;

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

Parameters

ParameterType
selector| Readonly<AxEventPath<unknown>> | (ingress: Readonly<AxEventIngress>) => string | Promise<string>

Returns

this


invalidate()

TypeScript
invalidate(invalidator: AxEventInvalidator): this;

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

Parameters

ParameterType
invalidatorAxEventInvalidator

Returns

this


match()

TypeScript
match(match: 
  | Readonly<AxEventMatcher>
  | (ingress: Readonly<AxEventIngress>) => boolean | Promise<boolean>): this;

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

Parameters

ParameterType
match| Readonly<AxEventMatcher> | (ingress: Readonly<AxEventIngress>) => boolean | Promise<boolean>

Returns

this


observe()

TypeScript
observe(observe?: (ingress: Readonly<AxEventIngress>, context: Readonly<AxEventContext>) => void | Promise<void>): this;

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

Parameters

ParameterType
observe?(ingress: Readonly<AxEventIngress>, context: Readonly<AxEventContext>) => void | Promise<void>

Returns

this


ordering()

TypeScript
ordering(ordering: "strict" | "relaxed"): this;

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

Parameters

ParameterType
ordering"strict" | "relaxed"

Returns

this


resume()

TypeScript
resume(target: AxEventTarget<any, any>): this;

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

Parameters

ParameterType
targetAxEventTarget<any, any>

Returns

this


sources()

TypeScript
sources(...sources: string[]): this;

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

Parameters

ParameterType
sourcesstring[]

Returns

this


subjects()

TypeScript
subjects(...subjects: string[]): this;

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

Parameters

ParameterType
subjectsstring[]

Returns

this


types()

TypeScript
types(...types: string[]): this;

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

Parameters

ParameterType
typesstring[]

Returns

this


wake()

TypeScript
wake(target: AxEventTarget<any, any>): this;

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

Parameters

ParameterType
targetAxEventTarget<any, any>

Returns

this

Docs