Universal Music Theory Library - v0.12.0
    Preparing search index...

    Interface ScaleMatch

    A scale that contains every note of the set.

    interface ScaleMatch {
        aliases: string[];
        extra: string[];
        name: string;
        notes: string[];
        root: string;
        rootIsTonic: boolean;
        tier: number;
        type: string;
    }
    Index

    Properties

    aliases: string[]

    Other names of the same pattern in SCALE_PATTERNS ('ionian', 'greek-hypolydian').

    extra: string[]

    Scale notes that are not in the set.

    name: string

    Scale symbol, readable by parseScaleSymbol: 'C major'.

    notes: string[]

    Notes of the scale, spelled.

    root: string

    Root note name: 'C', 'F#'.

    rootIsTonic: boolean

    The scale's root is the tonic (given, or the lowest note).

    tier: number

    0 common (diatonic modes, harmonic and melodic minor, pentatonics, blues), 1 other families, 2 regional and symmetric collections, 3 chromatic.

    type: string

    Scale type, a key of SCALE_PATTERNS: 'major', 'dorian'.