Sanity Library Reference Docs
    Preparing search index...

    Interface DiffEntry

    interface DiffEntry {
        docId: string;
        existing?: Record<string, unknown>;
        expected: Record<string, unknown>;
        name: string;
        status: "create" | "unchanged";
        version: number;
        warnings?: string[];
    }
    Index

    Properties

    docId existing? expected name status version warnings?

    Properties

    docId: string
    existing?: Record<string, unknown>

    The latest deployed document, system fields stripped — the prior shape to diff against. Absent when nothing is deployed yet.

    expected: Record<string, unknown>

    The document deploy would write — including the stamped version and contentHash.

    name: string
    status: "create" | "unchanged"
    version: number

    The version this deploy WOULD write, or the matched version when unchanged.

    warnings?: string[]

    The non-blocking warnings a deploy of this definition would report. Absent when there are none.

    Settings

    Member Visibility

    On This Page

    Properties