@tspro/web-music-score 4.0.0 → 4.0.1

package/dist/theory/index.d.mts

@@ -1,44 +1,60 @@
-import { N as Note } from '../note-BFa43I86.mjs';
-export { A as Accidental, d as DefaultGuitarNoteLabel, D as DefaultPitchNotation, G as GuitarNoteLabel, e as GuitarNoteLabelList, a as NoteLetter, P as ParsedNote, b as PitchNotation, c as PitchNotationList, S as SymbolSet, g as getPitchNotationName, f as validateGuitarNoteLabel, v as validatePitchNotation } from '../note-BFa43I86.mjs';
-import { D as Degree } from '../scale-C2pCNxdE.mjs';
-export { b as Interval, I as IntervalDirection, a as IntervalQuality, c as Scale, d as ScaleFactory, S as ScaleType, i as getDefaultScale, h as getScale, e as getScaleFactory, g as getScaleFactoryList, v as validateIntervalQuality, f as validateScaleType } from '../scale-C2pCNxdE.mjs';
-export { D as DefaultHandedness, a as DefaultTuningName, H as Handedness, T as TuningNameList, g as getTuningStrings, v as validateHandedness, b as validateTuningName } from '../guitar-DggbM2UL.mjs';
-export { A as AccidentalType, K as KeySignature, M as Mode, N as NoteLength, i as NoteLengthProps, h as NoteLengthStr, R as RhythmProps, c as Tempo, a as TimeSignature, T as TimeSignatureString, l as Tuplet, j as TupletRatio, f as alterTempoSpeed, g as getDefaultKeySignature, d as getDefaultTempo, b as getDefaultTimeSignature, e as getTempoString, v as validateNoteLength, k as validateTupletRatio } from '../tempo-BAYoZ_Li.mjs';
+import { N as Note } from '../note-eA2xPPiG.mjs';
+export { A as Accidental, d as DefaultGuitarNoteLabel, D as DefaultPitchNotation, G as GuitarNoteLabel, e as GuitarNoteLabelList, a as NoteLetter, P as ParsedNote, b as PitchNotation, c as PitchNotationList, S as SymbolSet, g as getPitchNotationName, f as validateGuitarNoteLabel, v as validatePitchNotation } from '../note-eA2xPPiG.mjs';
+import { D as Degree } from '../scale-BbDJTbrG.mjs';
+export { b as Interval, I as IntervalDirection, a as IntervalQuality, c as Scale, d as ScaleFactory, S as ScaleType, i as getDefaultScale, h as getScale, e as getScaleFactory, g as getScaleFactoryList, v as validateIntervalQuality, f as validateScaleType } from '../scale-BbDJTbrG.mjs';
+export { D as DefaultHandedness, a as DefaultTuningName, H as Handedness, T as TuningNameList, g as getTuningStrings, v as validateHandedness, b as validateTuningName } from '../guitar-DdexKdN6.mjs';
+export { A as AccidentalType, K as KeySignature, M as Mode, N as NoteLength, i as NoteLengthProps, h as NoteLengthStr, R as RhythmProps, c as Tempo, a as TimeSignature, T as TimeSignatureString, l as Tuplet, j as TupletRatio, f as alterTempoSpeed, g as getDefaultKeySignature, d as getDefaultTempo, b as getDefaultTimeSignature, e as getTempoString, v as validateNoteLength, k as validateTupletRatio } from '../tempo-CtUhvJbr.mjs';
 
+/** Chord info type. */
 type ChordInfo = {
     name: string;
     degrees: Degree[];
 };
+/** Chord class. */
 declare class Chord {
     readonly chordInfo: ChordInfo;
     readonly rootNote: Note;
+    /** Chord name. */
     readonly name: string;
+    /** Notes of this chord. */
     readonly notes: Note[];
+    /** Notes that are omitted in this chord (partial chord). */
     readonly omitNotes: boolean[];
+    /** Bass note if not chord root note (e.g. "B" in "C/B"). */
     readonly slashBassNote?: Note;
     private constructor();
+    /**
+     * Get all chords that can be made up with given notes.
+     * @param notes - Array of notes.
+     * @returns - Array of chords.
+     */
     static getChords(notes: ReadonlyArray<Note>): ReadonlyArray<Chord>;
     private replaceWith;
     /**
-     * @returns Chord name e.g. "C/B"
+     * Get chord string presentation.
+     * @returns Chord string presentation (e.g. "C/B").
      */
     toString(): string;
     /**
-     * @returns Degree notation string, e.g. "E - 1(C) - 3(E) - 5(G)"
+     * Get degree notation string (e.g. "E - 1(C) - 3(E) - 5(G)").
+     * @returns Degree notation string.
      */
     getDegreeNotationString(): string;
     /**
-     * @returns Omitted degrees string e.g. "Omits 5(G), 9(D)"
+     * Get string presentation of omitted degrees (e.g. "Omits 5(G), 9(D)").
+     * @returns - String presentation of omitted degrees.
      */
     getOmittedDegreesString(): string;
     /**
-     * @param i - Degree index
-     * @returns Degree string for given degree index, e.g. "3"
+     * Degree index for given degree index (e.g. "3").
+     * @param i - Chord degree index (e.g. 0 is first note degree of chord).
+     * @returns Degree string.
      */
     private getDegreeStr;
     /**
-     * @param i - Degree index
-     * @returns Note string for given degree index, e.g. "E"
+     * Get note name for given degree index (e.g. "E").
+     * @param i - Chord degree index (e.g. 0 is first note degree of chord).
+     * @returns - Note name string.
      */
     private getNoteStr;
 }

package/dist/theory/index.d.ts

@@ -1,44 +1,60 @@
-import { N as Note } from '../note-CcVdUFqS.js';
-export { A as Accidental, d as DefaultGuitarNoteLabel, D as DefaultPitchNotation, G as GuitarNoteLabel, e as GuitarNoteLabelList, a as NoteLetter, P as ParsedNote, b as PitchNotation, c as PitchNotationList, S as SymbolSet, g as getPitchNotationName, f as validateGuitarNoteLabel, v as validatePitchNotation } from '../note-CcVdUFqS.js';
-import { D as Degree } from '../scale-CvPbJvfN.js';
-export { b as Interval, I as IntervalDirection, a as IntervalQuality, c as Scale, d as ScaleFactory, S as ScaleType, i as getDefaultScale, h as getScale, e as getScaleFactory, g as getScaleFactoryList, v as validateIntervalQuality, f as validateScaleType } from '../scale-CvPbJvfN.js';
-export { D as DefaultHandedness, a as DefaultTuningName, H as Handedness, T as TuningNameList, g as getTuningStrings, v as validateHandedness, b as validateTuningName } from '../guitar-cNmE-EvH.js';
-export { A as AccidentalType, K as KeySignature, M as Mode, N as NoteLength, i as NoteLengthProps, h as NoteLengthStr, R as RhythmProps, c as Tempo, a as TimeSignature, T as TimeSignatureString, l as Tuplet, j as TupletRatio, f as alterTempoSpeed, g as getDefaultKeySignature, d as getDefaultTempo, b as getDefaultTimeSignature, e as getTempoString, v as validateNoteLength, k as validateTupletRatio } from '../tempo-r2sb6Ku2.js';
+import { N as Note } from '../note-eA2xPPiG.js';
+export { A as Accidental, d as DefaultGuitarNoteLabel, D as DefaultPitchNotation, G as GuitarNoteLabel, e as GuitarNoteLabelList, a as NoteLetter, P as ParsedNote, b as PitchNotation, c as PitchNotationList, S as SymbolSet, g as getPitchNotationName, f as validateGuitarNoteLabel, v as validatePitchNotation } from '../note-eA2xPPiG.js';
+import { D as Degree } from '../scale-B2Icbetz.js';
+export { b as Interval, I as IntervalDirection, a as IntervalQuality, c as Scale, d as ScaleFactory, S as ScaleType, i as getDefaultScale, h as getScale, e as getScaleFactory, g as getScaleFactoryList, v as validateIntervalQuality, f as validateScaleType } from '../scale-B2Icbetz.js';
+export { D as DefaultHandedness, a as DefaultTuningName, H as Handedness, T as TuningNameList, g as getTuningStrings, v as validateHandedness, b as validateTuningName } from '../guitar-CaZJDA05.js';
+export { A as AccidentalType, K as KeySignature, M as Mode, N as NoteLength, i as NoteLengthProps, h as NoteLengthStr, R as RhythmProps, c as Tempo, a as TimeSignature, T as TimeSignatureString, l as Tuplet, j as TupletRatio, f as alterTempoSpeed, g as getDefaultKeySignature, d as getDefaultTempo, b as getDefaultTimeSignature, e as getTempoString, v as validateNoteLength, k as validateTupletRatio } from '../tempo-Dt8aHpol.js';
 
+/** Chord info type. */
 type ChordInfo = {
     name: string;
     degrees: Degree[];
 };
+/** Chord class. */
 declare class Chord {
     readonly chordInfo: ChordInfo;
     readonly rootNote: Note;
+    /** Chord name. */
     readonly name: string;
+    /** Notes of this chord. */
     readonly notes: Note[];
+    /** Notes that are omitted in this chord (partial chord). */
     readonly omitNotes: boolean[];
+    /** Bass note if not chord root note (e.g. "B" in "C/B"). */
     readonly slashBassNote?: Note;
     private constructor();
+    /**
+     * Get all chords that can be made up with given notes.
+     * @param notes - Array of notes.
+     * @returns - Array of chords.
+     */
     static getChords(notes: ReadonlyArray<Note>): ReadonlyArray<Chord>;
     private replaceWith;
     /**
-     * @returns Chord name e.g. "C/B"
+     * Get chord string presentation.
+     * @returns Chord string presentation (e.g. "C/B").
      */
     toString(): string;
     /**
-     * @returns Degree notation string, e.g. "E - 1(C) - 3(E) - 5(G)"
+     * Get degree notation string (e.g. "E - 1(C) - 3(E) - 5(G)").
+     * @returns Degree notation string.
      */
     getDegreeNotationString(): string;
     /**
-     * @returns Omitted degrees string e.g. "Omits 5(G), 9(D)"
+     * Get string presentation of omitted degrees (e.g. "Omits 5(G), 9(D)").
+     * @returns - String presentation of omitted degrees.
      */
     getOmittedDegreesString(): string;
     /**
-     * @param i - Degree index
-     * @returns Degree string for given degree index, e.g. "3"
+     * Degree index for given degree index (e.g. "3").
+     * @param i - Chord degree index (e.g. 0 is first note degree of chord).
+     * @returns Degree string.
      */
     private getDegreeStr;
     /**
-     * @param i - Degree index
-     * @returns Note string for given degree index, e.g. "E"
+     * Get note name for given degree index (e.g. "E").
+     * @param i - Chord degree index (e.g. 0 is first note degree of chord).
+     * @returns - Note name string.
      */
     private getNoteStr;
 }