Interface DeepDiffResult

Complete result of a deep diff operation

interface DeepDiffResult {
    changes: DiffChange[];
    formatted: string;
    summary: {
        added: number;
        modified: number;
        removed: number;
        totalPaths: number;
        unchanged: number;
    };
}

Properties

changes formatted summary

Properties

changes

changes: DiffChange[]

Array of all detected changes

formatted

formatted: string

Human-readable formatted diff output suitable for display or logging

summary

summary: {
    added: number;
    modified: number;
    removed: number;
    totalPaths: number;
    unchanged: number;
}

Summary statistics about the diff

Type declaration

  • added: number

    Number of properties/values that were added

  • modified: number

    Number of properties/values that were modified

  • removed: number

    Number of properties/values that were removed

  • totalPaths: number

    Total number of paths examined

  • unchanged: number

    Number of properties/values that remained unchanged (if tracked)

Settings

Member Visibility

Theme

On This Page

changesformattedsummary