Hiyve Components - v1.0.0
    Preparing search index...

    Type Alias NoteNameIdSettings

    NoteNameIdSettings: Omit<NoteIdSettings, "byEar" | "playAnswer"> & {
        alteredShare?: number;
        barRule?: readonly BarRuleSign[];
        keySignatures?: readonly number[];
        naturalShare?: number;
        spelling?: AccidentalSpelling;
    }

    How name-the-note cards are made: what @hiyve/music-theory asks, read from the staff.

    Type Declaration

    • OptionalalteredShare?: number

      With keySignatures, how often the note is one the signature alters, 0 to 1 (default: 0.5; 1 asks only altered notes, for a first card)

    • OptionalbarRule?: readonly BarRuleSign[]

      Ask a note in a short printed bar — four quarter notes in 4/4 — whose letter has a sign on an earlier note of the bar, and none of its own: after a sharp or a flat it keeps that sign (F after F♯ is F♯); after a natural that cancels one (F♯, then F♮), it is the plain letter. One of the signs given is drawn per card; the target is pointed at, and its plain and signed names are both offered. When given, keySignatures, accidentals, spelling and naturalShare are not consulted (default: none — the note is read on its own)

    • OptionalkeySignatures?: readonly number[]

      Key signatures to read the note under, as sharps (positive) or flats (negative), −7 to 7: each card shows one of them after the clef and a plain note. A note whose letter the signature alters is named with its sharp or flat ("F♯" under one sharp), and the plain letter is offered beside it; any other note keeps its plain name, and the letter with the signature's sign ("G♯") is offered beside it — so the signature has to be read every time. When given, accidentals is not consulted; 0 (no sharps or flats) is skipped (default: none — the note is read on its own)

    • OptionalnaturalShare?: number

      How often the note is written with a natural sign, 0 to 1 (default: 0). Under keySignatures, the natural cancels the signature on a note it alters — F♮ under one sharp — and the answer is the plain letter, with the signature's name (F♯) beside it. With accidentals and no key signature, a natural is written with its sign before it and named plainly, with its sharp or flat beside it. 1 writes a natural on every card, for a first card

    • Optionalspelling?: AccidentalSpelling

      With accidentals, how the sharps and flats are spelled: 'sharps' writes every black key as a sharp, 'flats' as a flat, and the names offered keep to the same spelling (default: 'both' — each black key asked both ways). Whatever the spelling, a sharp or flat answer always has its plain letter beside it (F beside F♯), so the sign has to be read, and no two names of one sound are ever offered together (never G♭ beside F♯). Not consulted under keySignatures