Class Note

constructor

• new Note(pitch: number, accidental: number): Note

  Parameters

  • pitch: number
  • accidental: number

  Returns Note

Readonlyaccidental

Readonlypitch

naturalNote

• get naturalNote(): NaturalNote

  Returns NaturalNote

noteId

• get noteId(): number

  Returns number

octave

• get octave(): number

  Returns number

pitchMod7

• get pitchMod7(): number

  Returns number

equals

• equals(note: Note): boolean

  Parameters

  • note: Note

  Returns boolean

format

• format(pitchNotation: PitchNotation, symbolSet: SymbolSet): string

  Parameters

  • pitchNotation: PitchNotation
  • symbolSet: SymbolSet

  Returns string

formatOmitOctave

• formatOmitOctave(symbolSet: SymbolSet): string

  Parameters

  • symbolSet: SymbolSet

  Returns string

getPitchInOctave

• getPitchInOctave(octave: number): number

  Parameters

  • octave: number

  Returns number

StaticcompareFunc

• compareFunc(a: Note, b: Note): -1 | 0 | 1

  Parameters

  • a: Note
  • b: Note

  Returns -1 | 0 | 1

StaticgetAccidental

• getAccidental(accidentalSymbol: string): NonNullable<undefined | Accidental>

  Parameters

  • accidentalSymbol: string

  Returns NonNullable<undefined | Accidental>

StaticgetAccidentalSymbol

• getAccidentalSymbol(
      accidental: Accidental,
      symbolsSet: SymbolSet,
  ): undefined | string

  Parameters

  • accidental: Accidental
  • symbolsSet: SymbolSet

  Returns undefined | string

StaticgetNaturalNote

• getNaturalNote(pitch: number): NaturalNote

  Parameters

  • pitch: number

  Returns NaturalNote

StaticgetNaturelNotePitch

• getNaturelNotePitch(naturalNote: string, octave?: number): number

  Parameters

  • naturalNote: string
  • Optionaloctave: number

  Returns number

StaticgetNote

• getNote(noteName: string): Note

  Parameters

  • noteName: string

  Returns Note

StaticgetNoteById

• getNoteById(noteId: number, scale?: Scale): Note

  Parameters

  • noteId: number
  • Optionalscale: Scale

  Returns Note

StaticgetScientificNoteName

• getScientificNoteName(noteName: string, symbolSet: SymbolSet): string

  Parameters

  • noteName: string
  • symbolSet: SymbolSet

  Returns string

StaticisValidNoteName

• isValidNoteName(noteName: string): boolean

  Parameters

  • noteName: string

  Returns boolean

StaticparseNote

• parseNote(noteName: string): undefined | Readonly<ParsedNote>

  Parameters

  • noteName: string

  Returns undefined | Readonly<ParsedNote>

StaticremoveDuplicates

• removeDuplicates(notes: readonly Note[]): Note[]

  Remove duplicate notes.

  Parameters

  • notes: readonly Note[]

    Array of notes.

  Returns Note[]

  Sorted set of notes.

StaticreplaceAccidentalSymbols

• replaceAccidentalSymbols(str: string, symbolSet: SymbolSet): string

  Parameters

  • str: string
  • symbolSet: SymbolSet

  Returns string

Staticsort

• sort(notes: readonly Note[]): Note[]

  Sort notes by pitch in ascending order.

  Parameters

  • notes: readonly Note[]

    Array of notes.

  Returns Note[]

  Sorted array of notes.

StaticvalidateAccidental

• validateAccidental(acc: number): Accidental

  Parameters

  • acc: number

  Returns Accidental

StaticvalidateNaturalNote

• validateNaturalNote(note: string): NaturalNote

  Parameters

  • note: string

  Returns NaturalNote

StaticvalidateNoteId

• validateNoteId(noteId: number): number

  Parameters

  • noteId: number

  Returns number

StaticvalidateOctave

• validateOctave(octave: number): number

  Parameters

  • octave: number

  Returns number

StaticvalidatePitch

• validatePitch(pitch: number): number

  Parameters

  • pitch: number

  Returns number