withInterruptBinding

function withInterruptBinding(descriptor, binding): Interrupt;

Defined in: packages/ai/src/interrupt-resume.ts:954

Attach a resume binding to an interrupt descriptor, under INTERRUPT_BINDING_METADATA_KEY.

This is the supported way to make an interrupt resumable by this package. The descriptor keeps its AG-UI shape; only metadata gains the namespaced key. Pass the unopened form (no interruptedRunId / generation) when emitting from inside a run — those fields are stamped as the run finishes.

Parameters#

descriptor#

Interrupt

binding#

| InterruptBinding | Omit<ResponseSchemaInterruptBindingBase & object, "interruptedRunId" | "generation"> | Omit<ResponseSchemaInterruptBindingBase & object, "interruptedRunId" | "generation"> | Omit<InterruptBindingBase & object, "interruptedRunId" | "generation">

Returns#

Interrupt