Sanity Library Reference Docs
    Preparing search index...

    Interface WorkflowInstanceList

    A reactive instance list: instances is set only for a ready snapshot.

    interface WorkflowInstanceList {
        error: {} | undefined;
        instances: readonly WorkflowInstance[] | undefined;
        loading: boolean;
        unreadable: readonly InvalidDoc[];
    }
    Index

    Properties

    error: {} | undefined

    Set when the live read itself failed. Clears when the stream recovers.

    instances: readonly WorkflowInstance[] | undefined
    loading: boolean

    True only while the observer snapshot is pending. An empty instances with loading: false and no failure is a confirmed "none".

    unreadable: readonly InvalidDoc[]

    Rows the read discipline refused (InvalidDoc: a newer data model, or a corrupt shape) — skipped from instances and flagged here, so one bad row can't fail the listing while a silently short list stays impossible. Empty when every row parsed.