Skip to content

@checkout-kit/core / RunnerContext

Interface: RunnerContext ​

Properties ​

PropertyModifierTypeDescription
deadlinereadonlynumberWall-clock deadline; runners must give up and report a timeout by then.
mountreadonlyMountHandle | nullWhere a visible action may render. null when the host offered no mount point.
returnUrlreadonlystringAbsolute URL the provider should send the browser back to. Built by the host.
signalreadonlyAbortSignal-
surfacereadonlyActionSurfaceThe surface actually chosen. Usually action.surface, but a host may move a frame challenge into the whole window, and the runner needs to know which it is running.

Methods ​

report() ​

ts
report(progress): void;

Parameters ​

ParameterType
progress{ detail?: string; stage: string; }
progress.detail?string
progress.stagestring

Returns ​

void

Apache-2.0 · Headless engine, provider adapters and runnable examples.