Interface ChangeObject

src/types.ts:1–19

export interface ChangeObject<ValueT> {
  /**
   * The concatenated content of all the tokens represented by this change object - i.e. generally the text that is either added, deleted, or common, as a single string.
   * In cases where tokens are considered common but are non-identical (e.g. because an option like `ignoreCase` or a custom `comparator` was used), the value from the *new* string will be provided here.
   */
  value: ValueT;
  /**
   * true if the value was inserted into the new string, otherwise false
   */
  added: boolean;
  /**
   * true if the value was removed from the old string, otherwise false
   */
  removed: boolean;
  /**
   * How many tokens (e.g. chars for `diffChars`, lines for `diffLines`) the value in the change object consists of
   */
  count: number;
}

// Name "Change" is used here for consistency with the previous type definitions from
// DefinitelyTyped. I would *guess* this is probably the single most common type for people to