Interface Options<T, K>

Configuration options for PropChangeTracker.

interface Options<T extends object, K extends keyof T> {
    defaultEquals?: EqualityComparator<unknown>;
    equals?: EqualityComparators<T, K>;
    initialMode?: "undefined" | "changed" | "baseline";
    keys: readonly K[];
}

Type Parameters

T extends object
K extends keyof T

Index

Properties

defaultEquals? equals? initialMode? keys

Properties

`Optional`defaultEquals

defaultEquals?: EqualityComparator<unknown>

Equality comparator used when a property-specific comparator is not supplied.

Default Value

Object.is

`Optional`equals

equals?: EqualityComparators<T, K>

Optional equality comparators for individual properties.

`Optional`initialMode

initialMode?: "undefined" | "changed" | "baseline"

Controls the result of the first check after construction or PropChangeTracker.reset.

'changed': every tracked property is reported as changed.
'baseline': the first values establish the baseline and no changes are reported.
'undefined': each first value is compared against undefined.

Default Value

'changed'

keys

keys: readonly K[]

Properties to track. The order is retained when iterating changed properties or calling PropChangeTracker.Data.ChangeSet.toArray.