Sanity Library Reference Docs
    Preparing search index...
    interface WorkflowCommitOptions {
        tag?: string;
        visibility?: WorkflowVisibility;
    }
    Index

    Properties

    Properties

    tag?: string

    Request tag for request-log attribution — see WorkflowFetchOptions.tag; not the workflow-domain deployment tag. The engine stamps every write with an operation-scoped workflow.* tag.

    visibility?: WorkflowVisibility

    When the mutation becomes visible to subsequent queries. The engine reads its own writes back through GROQ (fetch) — a freshly-spawned child listed by id, a just-deployed definition — so single-document writes (create, patch().commit()) commit 'sync': the change is query-visible before the call resolves and the next read can't miss it. @sanity/client already defaults to 'sync', but the engine states it rather than depend on a transport default a consumer's client config could change underneath it. (Transactions ride that same default — see WorkflowTransaction.commit.)