Type Alias CompareChangeSet<TKey>

Result of compareObjectData

type CompareChangeSet<TKey extends string | number> = {
    added: Record<TKey, unknown>;
    changed: Record<TKey, unknown>;
    children: Record<TKey, CompareChangeSet<string | number>>;
    hasChanged: boolean;
    isArray: boolean;
    removed: TKey[];
    summary: ChangeRecord<TKey>[];
}

Type Parameters

TKey extends string | number

Index

Properties

added changed children hasChanged isArray removed summary

Properties

added

added: Record<TKey, unknown>

Fields that have been added

changed

changed: Record<TKey, unknown>

Values that have changed

children

children: Record<TKey, CompareChangeSet<string | number>>

Results for child objects

hasChanged

hasChanged: boolean

True if there are any changes

isArray

isArray: boolean

True if value is an array

removed

removed: TKey[]

Fields that have been removed

summary

summary: ChangeRecord<TKey>[]

Summary of changes