@libraz/libcantus - v1.1.0
    Preparing search index...

    Type Alias Conflict

    A note that clashes with the harmony sounding beneath it.

    type Conflict = {
        beat: number;
        trackName: string;
        trackIndex: number;
        originalIndex?: number;
        noteId: number;
        pitch: number;
        labels: TheoryLabel[];
        safety: NoteSafety;
        reasons: number;
        resolveTo?: number;
        suggestions?: number[];
        rationale?: string;
    }
    Index
    beat: number
    trackName: string
    trackIndex: number

    The clashing track's index in the caller's input array.

    originalIndex?: number

    The note's index in that track's own note array.

    noteId: number

    The id the note carries in TrackAnalysis.notes.

    pitch: number
    labels: TheoryLabel[]

    The note's theory labels at its onset, so a caller can tell a genuine clash from a passing tone, a neighbour, or a prepared suspension — all of which are ordinary non-chord tones that still evaluate as unsafe.

    safety: NoteSafety

    The clash severity: NoteSafety.Warning or NoteSafety.Dissonant.

    reasons: number
    resolveTo?: number

    Preferred stepwise resolution, when the safety evaluator provides one.

    suggestions?: number[]

    Nearby fully safe replacement pitches, nearest first.

    rationale?: string