Sanity Library Reference Docs
    Preparing search index...

    Interface CreateRuntimeOptions

    interface CreateRuntimeOptions {
        clientFactory?: RuntimeClientFactory;
        clock?: Clock;
        context: RuntimeFunctionContext;
        effects?: Readonly<Record<string, EffectHandler>>;
        telemetry?: WorkflowTelemetryLogger;
    }
    Index

    Properties

    clientFactory? clock? context effects? telemetry?

    Properties

    clientFactory?: RuntimeClientFactory

    Overrides client construction. Defaults to a CDN-less client on the raw perspective, pinned to the engine's API version.

    clock?: Clock
    context: RuntimeFunctionContext

    The context the handler was invoked with. Its clientOptions.token and clientOptions.apiHost authorize the client.

    effects?: Readonly<Record<string, EffectHandler>>

    The effect handlers, keyed by effect name: the registry the generated effect-handlers/all.ts exports. Runtime.drain and the drainEffects of Runtime.engine run them; the heartbeat and start run none.

    telemetry?: WorkflowTelemetryLogger

    Settings

    Member Visibility

    On This Page

    Properties