@eagleoutice/flowr - v2.9.14
    Preparing search index...

    Interface WriteableDifferenceReport

    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(): readonly string[] | undefined;
        isEqual(): boolean;
    }

    Hierarchy (View Summary)

    Implemented by

    Hierarchy-Diagram

    UML class diagram of WriteableDifferenceReport
    Index

    Methods

    addComment comments isEqual

    Methods

    • Parameters

      • comment: string

      Returns void

    • 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 readonly string[] | undefined

    Settings

    Member Visibility

    On This Page

    Methods