tree-changes/src/types.ts

Get changes between two versions of data with similar shape

type PlainObject = Record<string, any>;

export type Comparator = Array<string | any[]>;
export type Data = PlainObject | ValidTypes[];
export type Key = string | number;
export type KeyType<P, D> = P | D extends any[] ? Key : keyof P | keyof D;
export type ValidTypes = string | boolean | number | PlainObject;
export type Value = ValidTypes | ValidTypes[];

export interface Options<T = Key> {
  actual?: Value;
  filter?: boolean;
  key?: T;
  previous?: Value;
  type?: 'decreased' | 'increased';
}

export interface CompareValuesOptions<T = Key> {
  key?: T;
  type: 'added' | 'removed';
  value?: Value;
}

export interface TreeChanges<K> {
  added: (key?: K, value?: Value) => boolean;
  changed: (key?: K | string, actual?: Value, previous?: Value) => boolean;
  changedFrom: (key: K | string, previous: Value, actual?: Value) => boolean;
  decreased: (key: K, actual?: Value, previous?: Value) => boolean;
  emptied: (key?: K) => boolean;
  filled: (key?: K) => boolean;
  increased: (key: K, actual?: Value, previous?: Value) => boolean;
  removed: (key?: K, value?: Value) => boolean;
}