Skip to content

@checkout-kit/core / RunnerRegistry

Interface: RunnerRegistry ​

Methods ​

assertCovers() ​

ts
assertCovers(providerId, capabilities): void;

Fail at registration: a provider that can return an action this host cannot run is a bug to catch on boot, not halfway through a payment.

Parameters ​

ParameterType
providerIdstring
capabilitiesProviderCapabilities

Returns ​

void


register() ​

ts
register<K>(runner): void;

Type Parameters ​

Type Parameter
K extends PaymentActionKind

Parameters ​

ParameterType
runnerActionRunner<K>

Returns ​

void


resolve() ​

ts
resolve(action, surface?): AnyActionRunner | null;

Runner for this action, optionally forced onto another surface the host supports.

Parameters ​

ParameterType
actionPaymentAction
surface?ActionSurface

Returns ​

AnyActionRunner | null


supports() ​

ts
supports(kind, surface): boolean;

Parameters ​

ParameterType
kindPaymentActionKind
surfaceActionSurface

Returns ​

boolean

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