Interface IStringDiffModel

packages/nbdime/src/diff/model/string.ts:33–74

 * to cases where original content is in a string format.
 */
export interface IStringDiffModel extends IDiffModel {
  /**
   * Base value
   */
  base: string | null;

  /**
   * Remote value
   */
  remote: string | null;

  /**
   * Mimetype of the data the string represents.
   *
   * Can be used for things such as syntax highlighting.
   */
  mimetype: string;

  /**
   * Location of additions, as positions in the remote value.
   *
   * Locations should be sorted on the ranges' `from` position
   */
  additions: DiffRangePos[];

  /**
   * Location of deletions, as positions in the base value.
   *
   * Locations should be sorted on the ranges' `from` position
   */
  deletions: DiffRangePos[];

  /**
   * A function that will separate the diff into chunks.
   */
  getLineChunks(): Chunk[];

  /**
   * Create an iterator for iterating over the diffs in order
   */
  iterateDiffs(): StringDiffModel.DiffIter;
}

/**
 * Standard implementation of the IStringDiffModel interface.