Sanity Library Reference Docs
    Preparing search index...

    Interface Guard

    A stored workflow guard. Its string reads and authored lifecycle actions remain unresolved until stage entry produces the Lake-shaped documents deployed for that stage.

    interface Guard {
        description?: string;
        match: {
            actions: ("create" | "update" | "delete" | "publish" | "unpublish")[];
            idPatterns?: string[];
            idRefs?: string[];
            types?: string[];
        };
        metadata?: { [key: string]: string };
        name: string;
        predicate?: string;
        title?: string;
    }
    Index

    Properties

    description? match metadata? name predicate? title?

    Properties

    description?: string = ...
    match: {
        actions: ("create" | "update" | "delete" | "publish" | "unpublish")[];
        idPatterns?: string[];
        idRefs?: string[];
        types?: string[];
    } = ...
    metadata?: { [key: string]: string } = ...
    name: string = NonEmpty
    predicate?: string = ...
    title?: string = ...

    Settings

    Member Visibility

    On This Page

    Properties