require('sharp11').note
Contains a Note object, which can be created with note.create(). Methods of the Note object do not mutate it, they return a new object.
Returns a Note object given a note name and an optional octave number. The octave number can also be included in the note argument, so note.create('C', 4) and note.create('C4') do the same thing.
Returns a Note object given a range (array containing two Note objects or strings) within which the note must fall. The notes in the range array must have octave numbers.
Returns true if an object is a Note.
Returns a Note object given a note value.
Extracts the first valid note from a given string. For example, "Abm7b5" would return an A and "xyzc#5xyz" would return a C#5.
The Note object is the primary building block in Sharp11. It represents a note with an optional octave number. Functions that take note objects can always be passed strings instead and they will be automatically converted. Many functions that take note objects will behave differently depending on whether or not the note has an octave number. The Note constructor is accessible directly as .Note, however new instances should be created using .create() instead.
The name of the note, e.g., "Ab".
The name of the note with the octave number if there is one, e.g., "Ab4".
The letter of the note, e.g., "C".
The accidental of the note, i.e., "#", "b", "n", "##", or "bb".
The (optional) octave number of the note, i.e., an integer between 0 and 9, or null.
"#" for sharp keys, "b" for flat keys, null for C.
Returns an integer representing the note if it has an octave number or null otherwise. Enharmonically equivalent notes in the same octave have the same value. This value is the same as the MIDI note value.
Sharps the note, without doing any cleanup. This means a "C#" becomes a "C##" and a "C##" becomes a "D#". For a more useful result, call .clean() on the result.
Flats the note, without doing any cleanup. This means a "Bb" becomes a "Bbb" and a "Bbb" becomes an "Ab". For a more useful result, call .clean() on the result.
Shifts the note by a given number of half steps, positive or negative, without doing any cleanup. For a more useful result, call .clean() on the result.
Respells a note, getting rid of double accidentals, B#/Cb, and E#/Fb.
Returns an enharmonically equivalent note with a given accidental ('#', 'b', or 'n') if possible.
Returns the interval to a given note (Note object or string) as an Interval. Octave numbers are ignored, so note.create('C4').getInterval('G4') and note.create('C4').getInterval('G5') will both return a perfect fifth.
Transposes the note by an interval (string or Interval object). The interval will be transposed up unless down is truthy.
Octave numbers will be taken into account, and intervals up to a 14th are supported. For example, note.create('C4').transpose('P11') will return an F5.
Calls .transpose(interval, true).
Toggles the accidental of the note. For example: C# becomes Db, E# becomes F, and F## becomes G.
Returns the note in a given octave number.
Returns true if the note is enharmonic to a given note (Note object or string), ignoring octave numbers.
Returns true if the note is lower than a given note (Note object or string). If both notes have octave numbers, those octave numbers are used. Otherwise, it is assumed both notes have the same octave number.
Returns true if the note is higher than a given note (Note object or string). If both notes have octave numbers, those octave numbers are used. Otherwise, it is assumed both notes have the same octave number.
Returns true if the note has the same letter and accidental as a given note (Note object or string). If both notes have octave numbers, those octave numbers are used. Otherwise, it is assumed both notes have the same octave number.
Returns the number of half steps between note and a given note (Note object or string).
Returns true if note is enharmonic to any note in a given array of notes (Note objects or strings). Octave numbers are taken into account if both notes being compared have them, so note.create('C4').containedIn(['C', 'D', 'E']) returns true but note.create('C4').containedIn(['C5', 'D5', 'E5']) returns false.
Returns true if note is in a given range (inclusive). range is an array containing two elements, a lower bound and an upper bound (Note objects or strings). .inRange() uses .lowerThan() and .higherThan() internally, so the same rules regarding octave numbers apply.