Sanity Library Reference Docs
    Preparing search index...

    What one deployment's definitions require of a server-side runtime.

    interface RuntimeNeeds {
        drain: { effectNames: string[] };
        heartbeat: {
            spawnSites: DefinitionSpawnSite[];
            timeSites: TimeConditionSite[];
        };
        startWatch: { definitions: string[] };
        subjects: { acceptsAnyType: boolean; types: string[] };
        tag: string;
    }
    Index

    Properties

    drain: { effectNames: string[] }

    Type declaration

    • effectNames: string[]

      Declared effect names, sorted.

    heartbeat: { spawnSites: DefinitionSpawnSite[]; timeSites: TimeConditionSite[] }

    Type declaration

    • spawnSites: DefinitionSpawnSite[]

      Every site spawning children, whose parent needs re-evaluating when one of those children settles.

    • timeSites: TimeConditionSite[]

      Every condition site reading $now: a deadline nothing else ticks past.

    startWatch: { definitions: string[] }

    Type declaration

    • definitions: string[]

      Every autonomous definition, name ascending, including any no write can start. Hosting is not considered: which of these a watcher is emitted for is DeploymentPlan.emission's answer, not this one.

    subjects: { acceptsAnyType: boolean; types: string[] }

    Type declaration

    • acceptsAnyType: boolean
    • types: string[]

      Subject types across the deployment, sorted.

    tag: string