Sanity Library Reference Docs
    Preparing search index...

    Args for evaluateStart — the pre-flight read of startInstance's gates for a definition + the initialFields gathered so far (possibly none).

    interface EvaluateStartArgs {
        definition: string;
        initialFields?: InitialFieldValue[];
        version?: number;
    }
    Index

    Properties

    definition: string

    The definition's name — which deployed workflow would be started.

    initialFields?: InitialFieldValue[]

    The candidate seed, in StartInstanceArgs.initialFields shape. Partial mid-form input is expected and safe: the verdict is BINDABILITY-AWARE — when the predicate reads a declared entry these inputs don't supply, outcome reports 'unevaluable' and StartEvaluation.unboundReads names the entries, instead of the collapsed answer GROQ equality would otherwise produce (null == x is false, not null — a definitive-looking verdict one more input could overturn, in either direction).

    version?: number

    Optional explicit version. Defaults to the highest deployed version.