Sanity Library Reference Docs
    Preparing search index...

    Interface DeployDefinitionsArgs<T>

    interface DeployDefinitionsArgs<
        T extends WorkflowDefinitionInput<T> = WorkflowDefinition,
    > {
        definitions: T[];
        expectedMinReaderModel: number;
        resourceAliases?: ResourceAliases;
    }

    Type Parameters

    Index

    Properties

    definitions: T[]

    Authored definitions (the default — full compile-time checking) or loosely-typed fetched definition documents — the boundary parse normalizes either (WorkflowDefinitionInput).

    expectedMinReaderModel: number

    Highest reader model verified across runtimes sharing the workflow resource. The deploy gate compares this reviewed numeric literal with the submitted definitions; do not import either exported reader constant, because a dependency upgrade must not change it automatically.

    resourceAliases?: ResourceAliases

    Resource-alias bindings for this deploy (alias name → physical resource). A deploy-time abstraction ONLY: every @<alias>: reference in a definition is expanded to its bound physical resource before the deployed definition is fingerprinted and stored, and deploy fails closed on an unbound alias. Aliases never exist past deploy — no stored document carries one, the runtime never sees the map, and an alias-shaped ref reaching a runtime boundary is rejected as malformed. Omit for single-resource workflows (definitions referencing no aliases).