![\"npm](\"https://img.shields.io/npm/v/tonal-note.svg\")
\n![\"tonal\"](\"https://img.shields.io/badge/tonal-note-yellow.svg\"){kind=icon}
\n
tonal-note is a collection of functions to manipulate musical notes in scientific notation
This is part of tonal music theory library.
\nimport * as Note from "tonal-note"\n// or const Note = require("tonal-note")\nNote.name("bb2") // => "Bb2"\nNote.chroma("bb2") // => 10\nNote.midi("a4") // => 69\nNote.freq("a4") // => 440\nNote.oct("G3") // => 3\n\n// part of tonal\nconst Tonal = require("tonal")\n// or import Note from "tonal"\nTonal.Note.midi("d4") // => 62![\"npm](\"https://nodei.co/npm/tonal-note.png?mini=true\")
Number\n * [.freqToMidi](#module_Note.freqToMidi) ⇒ Integer\n * [.from](#module_Note.from)\n * [.simplify](#module_Note.simplify) ⇒ string\n * [.props()](#module_Note.props) ⇒ string\n * [.name()](#module_Note.name) ⇒ string\n * [.midiToFreq(note)](#module_Note.midiToFreq) ⇒ Number\n * [.chroma(note)](#module_Note.chroma) ⇒ Integer\n * [.altToAcc(props, [baseNote])](#module_Note.altToAcc) ⇒ string\n * [.build(midi, useSharps)](#module_Note.build) ⇒ string\n * _inner_\n * [~props](#module_Note..props) ⇒ Object\n * [~names(accTypes)](#module_Note..names) ⇒ Array\n * [~tokenize(str)](#module_Note..tokenize) ⇒ Array\n * [~midi(note)](#module_Note..midi) ⇒ Integer\n * [~freqToMidi(frequency)](#module_Note..freqToMidi) ⇒ Number\n * [~stepToLetter(step)](#module_Note..stepToLetter) ⇒ string\n * [~altToAcc(alt)](#module_Note..altToAcc) ⇒ string\n * [~simplify(note, useSameAccType)](#module_Note..simplify) ⇒ string\n\n\n\n### Note.midi ⇒ Number\nGet the frequency from midi number
\n\n**Kind**: static property of [Note](#module_Note) \n**Returns**: Number - the frequency or null if not valid note midi
\n\n| Param | Type | Description |\n| --- | --- | --- |\n| midi |Number | the note midi number
|\n| tuning |Number | (Optional) 440 by default
|\n\n\n\n### Note.freqToMidi ⇒Integer\nReturn the chroma of a note. The chroma is the numeric equivalent to the\npitch class, where 0 is C, 1 is C# or Db, 2 is D... 11 is B
\n\n**Kind**: static property of [Note](#module_Note) \n**Returns**: Integer - the chroma number
\n\n| Param | Type | Description |\n| --- | --- | --- |\n| note |string | the note name
|\n\n**Example** \n```js\nNote.chroma(\"Cb\") // => 11\n[\"C\", \"D\", \"E\", \"F\"].map(Note.chroma) // => [0, 2, 4, 5]\n```\n\n\n### Note.from\nDeprecated. This is kept for backwards compatibility only.\nUse Note.from instead
\n\n**Kind**: static property of [Note](#module_Note) \n\n\n### Note.simplify ⇒ string\nGet the simplified and enhramonic note of the given one.
\n\n**Kind**: static property of [Note](#module_Note) \n**Returns**: string - the enhramonic note
\n\n| Param | Type |\n| --- | --- |\n| note |string | \n\n**Example** \n```js\nNote.enharmonic(\"Db\") // => \"C#\"\nNote.enhramonic(\"C\") // => \"C\"\n```\n\n\n### Note.props() ⇒ string\nGiven a note name, return the note name or null if not valid note.\nThe note name will ALWAYS have the letter in upercase and accidentals\nusing # or b
\nCan be used to test if a string is a valid note name.
\n\n**Kind**: static method of [Note](#module_Note) \n\n| Param | Type |\n| --- | --- |\n| | Pitch \\| string | \n\n**Example** \n```js\nNote.name(\"cb2\") // => \"Cb2\"\n[\"c\", \"db3\", \"2\", \"g+\", \"gx4\"].map(Note.name) // => [\"C\", \"Db3\", null, null, \"G##4\"]\n```\n\n\n### Note.name() ⇒ string\nGet pitch class of a note. The note can be a string or a pitch array.
\n\n**Kind**: static method of [Note](#module_Note) \n**Returns**: string - the pitch class
\n\n| Param | Type |\n| --- | --- |\n| |string \\| Pitch | \n\n**Example** \n```js\nNote.pc(\"Db3\") // => \"Db\"\n[\"db3\", \"bb6\", \"fx2\"].map(Note.pc) // => [ \"Db\", \"Bb\", \"F##\"]\n```\n\n\n### Note.midiToFreq(note) ⇒ Number\nGet the frequency of a note
\n\n**Kind**: static method of [Note](#module_Note) \n**Returns**: Number - the frequency
\n\n| Param | Type | Description |\n| --- | --- | --- |\n| note |string \\| Number | the note name or midi note number
|\n\n**Example** \n```js\nNote.freq(\"A4\") // => 440\nNote.freq(69) // => 440\n```\n\n\n### Note.chroma(note) ⇒Integer\nGet the octave of the given pitch
\n\n**Kind**: static method of [Note](#module_Note) \n**Returns**: Integer - the octave or null if doesn"t have an octave or not a valid note
\n\n| Param | Type | Description |\n| --- | --- | --- |\n| note |string | the note
|\n\n**Example** \n```js\nNote.oct(\"C#4\") // => 4\nNote.oct(\"C\") // => null\nNote.oct(\"blah\") // => undefined\n```\n\n\n### Note.altToAcc(props, [baseNote]) ⇒string\nCreates a note name in scientific notation from note properties,\nand optionally another note name.\nIt receives an object with:
\nOptionally it receives another note as a "base", meaning that any prop not explicitly\nreceived on the first parameter will be taken from that base note. That way it can be used\nas an immutable "set" operator for a that base note
\n\n**Kind**: static method of [Note](#module_Note) \n**Returns**: string - the note name in scientific notation or null if not valid properties
\n\n| Param | Type | Description |\n| --- | --- | --- |\n| props |Object | the note properties
|\n| [baseNote] |string | note to build the result from. If given, it returns the result of applying the given props to this note.
|\n\n**Example** \n```js\nNote.from({ step: 5 }) // => \"A\"\nNote.from({ step: 1, acc: -1 }) // => \"Db\"\nNote.from({ step: 2, acc: 2, oct: 2 }) // => \"E##2\"\nNote.from({ step: 7 }) // => null\nNote.from({alt: 1, oct: 3}, \"C4\") // => \"C#3\"\n```\n\n\n### Note.build(midi, useSharps) ⇒string\nGiven a midi number, returns a note name. The altered notes will have\nflats unless explicitly set with the optional useSharps parameter.
Note](#module_Note) \n**Returns**: string - the note name
\n\n| Param | Type | Description |\n| --- | --- | --- |\n| midi |number | the midi note number
|\n| useSharps |boolean | (Optional) set to true to use sharps instead of flats
|\n\n**Example** \n```js\nNote.fromMidi(61) // => \"Db4\"\nNote.fromMidi(61, true) // => \"C#4\"\n// it rounds to nearest note\nNote.fromMidi(61.7) // => \"D4\"\n```\n\n\n### Note~props ⇒Object\nGet note properties. It returns an object with the following information:
\nThis function always returns an object with all this properties, but if it"s\nnot a valid note all properties will be null.
\nThe returned object can"t be mutated.
\n\n**Kind**: inner constant of [Note](#module_Note) \n**Returns**: Object - an object with the properties (or an object will all properties\nset to null if not valid note)
\n\n| Param | Type | Description |\n| --- | --- | --- |\n| note |string | the note name in scientific notation
|\n\n**Example** \n```js\nNote.props(\"fx-3\").name // => \"F##-3\"\nNote.props(\"invalid\").name // => null\nNote.props(\"C#3\").oct // => 3\nNote.props().oct // => null\n```\n\n\n### Note~names(accTypes) ⇒Array\nGet a list of note names (pitch classes) within a octave
\n\n**Kind**: inner method of [Note](#module_Note) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| accTypes | string | (Optional, by default " b#"). A string with the accidentals types: " " means no accidental, "#" means sharps, "b" mean flats, can be combined (see examples)
|\n\n**Example** \n```js\nNote.names(\" b\") // => [ \"C\", \"Db\", \"D\", \"Eb\", \"E\", \"F\", \"Gb\", \"G\", \"Ab\", \"A\", \"Bb\", \"B\" ]\nNote.names(\" #\") // => [ \"C\", \"C#\", \"D\", \"D#\", \"E\", \"F\", \"F#\", \"G\", \"G#\", \"A\", \"A#\", \"B\" ]\n```\n\n\n### Note~tokenize(str) ⇒Array\nSplit a string into tokens related to note parts.\nIt returns an array of strings [letter, accidental, octave, modifier]
It always returns an array
\n\n**Kind**: inner method of [Note](#module_Note) \n**Returns**: Array - an array of note tokens
\n\n| Param | Type |\n| --- | --- |\n| str |string | \n\n**Example** \n```js\nNote.tokenize(\"C#2\") // => [\"C\", \"#\", \"2\", \"\"]\nNote.tokenize(\"Db3 major\") // => [\"D\", \"b\", \"3\", \"major\"]\nNote.tokenize(\"major\") // => [\"\", \"\", \"\", \"major\"]\nNote.tokenize(\"##\") // => [\"\", \"##\", \"\", \"\"]\nNote.tokenize() // => [\"\", \"\", \"\", \"\"]\n```\n\n\n### Note~midi(note) ⇒ Integer\nGet the note midi number. It always return a number between 0 and 127
\n\n**Kind**: inner method of [Note](#module_Note) \n**Returns**: Integer - the midi number or null if not valid pitch
\n**See**: midi.toMidi \n\n| Param | Type | Description |\n| --- | --- | --- |\n| note |string \\| Number | the note to get the midi number from
|\n\n**Example** \n```js\nNote.midi(\"C4\") // => 60\nNote.midi(60) // => 60\n```\n\n\n### Note~freqToMidi(frequency) ⇒Number\nGet the midi number from a frequency in hertz. The midi number can\ncontain decimals (with two digits precission)
\n\n**Kind**: inner method of [Note](#module_Note) \n\n| Param | Type |\n| --- | --- |\n| frequency | Number | \n\n**Example** \n```js\nNote.freqToMidi(220)); //=> 57;\nNote.freqToMidi(261.62)); //=> 60;\nNote.freqToMidi(261)); //=> 59.96;\n```\n\n\n### Note~stepToLetter(step) ⇒ string\nGiven a step number return it's letter (0 = C, 1 = D, 2 = E)
\n\n**Kind**: inner method of [Note](#module_Note) \n**Returns**: string - the letter
\n\n| Param | Type |\n| --- | --- |\n| step |number | \n\n**Example** \n```js\nNote.stepToLetter(3) // => \"F\"\n```\n\n\n### Note~altToAcc(alt) ⇒ string\nGiven an alteration number, return the accidentals
\n\n**Kind**: inner method of [Note](#module_Note) \n\n| Param | Type |\n| --- | --- |\n| alt | Number | \n\n**Example** \n```js\nNote.altToAcc(-3) // => \"bbb\"\n```\n\n\n### Note~simplify(note, useSameAccType) ⇒ string\nSimplify the note: find an enhramonic note with less accidentals.
\n\n**Kind**: inner method of [Note](#module_Note) \n**Returns**: string - the simplfiied note or null if not valid note
\n\n| Param | Type | Description |\n| --- | --- | --- |\n| note |string | the note to be simplified
|\n| useSameAccType |boolean | (optional, true by default) set to true to ensure the returned note has the same accidental types that the given note
|\n\n**Example** \n```js\nNote.simplify(\"C##\") // => \"D\"\nNote.simplify(\"C###\") // => \"D#\"\nNote.simplify(\"C###\", false) // => \"Eb\"\nNote.simplify(\"B#4\") // => \"C5\"\n```\n","maintainers":[{"name":"danigb","email":"danigb@gmail.com"}],"time":{"modified":"2022-06-27T18:17:53.416Z","created":"2016-05-08T04:05:41.307Z","0.50.0":"2016-05-08T04:05:41.307Z","0.50.1":"2016-05-08T04:08:14.967Z","0.50.2":"2016-05-08T04:37:08.761Z","0.60.0":"2016-11-15T15:08:02.221Z","0.61.0":"2016-11-16T00:44:05.730Z","0.62.0":"2016-11-16T02:43:16.607Z","0.63.1":"2016-11-16T03:43:16.089Z","0.64.0":"2016-11-16T11:30:00.601Z","0.65.0":"2016-11-17T18:28:37.979Z","0.66.0":"2016-11-20T18:50:16.717Z","0.67.0":"2016-11-22T00:24:29.238Z","0.68.0":"2016-11-28T00:57:42.903Z","0.68.1":"2017-01-31T09:25:44.954Z","0.69.0":"2017-02-16T23:04:43.125Z","0.69.2":"2017-04-04T20:50:39.589Z","0.69.3":"2017-04-04T21:10:22.148Z","0.69.4":"2017-04-04T21:49:11.680Z","0.69.5":"2017-04-04T22:04:36.235Z","0.69.6":"2017-05-05T17:22:24.684Z","0.69.7":"2017-07-08T10:51:45.756Z","0.69.8":"2017-08-06T16:08:14.295Z","0.69.9":"2017-08-06T16:09:51.563Z","1.0.0-0":"2017-09-26T21:50:35.113Z","1.0.0-1":"2017-09-29T07:31:38.108Z","1.0.0-pre2":"2017-09-29T09:04:37.311Z","1.0.0-pre3":"2017-09-29T09:22:05.633Z","1.0.0-pre4":"2017-10-01T10:11:09.799Z","1.0.0-pre5":"2017-10-01T16:29:03.031Z","1.0.0-pre6":"2017-10-03T23:52:07.448Z","1.0.0":"2017-10-04T15:23:32.357Z","1.1.0":"2017-10-24T22:32:26.550Z","1.1.2":"2018-01-04T22:24:55.041Z","2.0.0":"2018-09-11T15:55:47.915Z","2.1.0":"2018-11-04T14:46:10.677Z","2.1.2":"2018-11-15T05:58:39.450Z","2.2.0":"2019-02-14T23:23:42.853Z","2.2.1":"2019-02-15T00:17:49.129Z","2.2.2":"2019-04-03T19:58:32.408Z"},"keywords":["note","music","theory","tonal"],"author":{"name":"danigb"},"license":"MIT","readmeFilename":"README.md","users":{"rchk":true,"jmiziolek":true},"repository":{"type":"git","url":"https://github.com/danigb/tonal/packages/note"}}