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

AxPushEventSource

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

Implements

Constructors

Constructor

TypeScript
new AxPushEventSource(id: string, requiresDurable: boolean): AxPushEventSource;

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

Parameters

ParameterTypeDefault value
idstringundefined
requiresDurablebooleanfalse

Returns

AxPushEventSource

Properties

PropertyModifierTypeDefault value
idreadonlystringundefined
requiresDurablereadonlybooleanfalse

Methods

publish()

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

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

Parameters

ParameterType
ingressReadonly<AxEventIngress>
signal?AbortSignal

Returns

Promise<AxEventPublishReceipt>


start()

TypeScript
start(context: Readonly<AxEventSourceContext>): AxEventSourceHandle;

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

Parameters

ParameterType
contextReadonly<AxEventSourceContext>

Returns

AxEventSourceHandle

Implementation of

AxEventSource.start

Docs