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

AxEventSink

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

Type Parameters

Type ParameterDefault type
OUTunknown

Properties

PropertyType
idstring

Methods

write()

TypeScript
write(output: OUT, context: Readonly<AxEventSinkContext<OUT>>): void | Promise<void>;

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

Parameters

ParameterType
outputOUT
contextReadonly<AxEventSinkContext<OUT>>

Returns

void | Promise<void>


writeChunk()?

TypeScript
optional writeChunk(chunk: Readonly<AxGenDeltaOut<OUT>>, context: Readonly<AxEventSinkContext<OUT>>): void | Promise<void>;

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

Parameters

ParameterType
chunkReadonly<AxGenDeltaOut<OUT>>
contextReadonly<AxEventSinkContext<OUT>>

Returns

void | Promise<void>

Docs