Unifies the shape of all difference reports. They should have an array of comments on the potential differences/equality of the structures and a function to check if they are really equal.

interface WriteableDifferenceReport {
    addComment(comment: string): void;
    comments(): undefined | readonly string[];
    isEqual(): boolean;
}

Hierarchy (view full)

Implemented by

Hierarchy-Diagram

UML class diagram of WriteableDifferenceReport

Methods

  • A human-readable description of differences during the comparison In combination with isEqual this can be used to provide detailed explanation on equal structures as well (e.g., if structures could be equal).

    Returns undefined | readonly string[]