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

    Type Alias SpelledKeyScale

    SpelledKeyScale: KeyScale & { tonic: NoteData; variant: KeyVariant }

    A key/scale with the spelling it is conventionally written in beside it.

    What the key builders hand back. It is a KeyScale — every reader that wants only the pitch classes takes it unchanged — and it carries the tonic those pitch classes are conventionally written on, so it also satisfies the entry points whose answer depends on how the key is written.

    Carrying the spelling here is what lets those entry points refuse a bare KeyScale without refusing the library's own builders. A bare scale reaching one of them has had a spelling and lost it, which is the defect; a built key never lost one.

    Type Declaration

    • tonic: NoteData

      The tonic the key is conventionally written on.

    • variant: KeyVariant

      The scale form the mask stands in.