![\"npm](\"https://img.shields.io/npm/v/tonal-interval.svg\")
\n![\"tonal\"](\"https://img.shields.io/badge/tonal-interval-yellow.svg\"){kind=icon}
\n
tonal-interval is a collection of functions to create and manipulate music intervals.
The intervals are strings in shorthand notation. Two variations are supported:
\nThe problem with the standard shorthand notation is that some strings can be\nparsed as notes or intervals, for example: "A4" can be note A in 4th octave\nor an augmented four. To remove ambiguity, the prefered notation in tonal is the\ninverse shortand notation.
\nThis is part of tonal music theory library.
\n// es6\nimport * as Interval from "tonal-interval"\n// es5\nconst Interval = require("tonal-interval")\n// part of tonal\nimport { Interval } from "tonal"\n\nInterval.semitones("4P") // => 5\nInterval.invert("3m") // => "6M"\nInterval.simplify("9m") // => "2m"![\"npm](\"https://nodei.co/npm/tonal-interval.png?mini=true\")
string\n * [.name(ivl)](#module_Interval.name) ⇒ Integer\n * [.semitones(str)](#module_Interval.semitones) ⇒ Number\n * [.chroma(interval)](#module_Interval.chroma) ⇒ Integer\n * [.ic(props)](#module_Interval.ic) ⇒ string\n * [.build(interval)](#module_Interval.build) ⇒ string\n * [.simplify(interval)](#module_Interval.simplify) ⇒ string\n * _inner_\n * [~names(qualities)](#module_Interval..names) ⇒ Array\n * [~props(interval)](#module_Interval..props) ⇒ Object\n * [~num(interval)](#module_Interval..num) ⇒ Integer\n * [~fromSemitones(num)](#module_Interval..fromSemitones) ⇒ string\n\n\n\n### Interval.num(interval) ⇒ string\nGet interval name. Can be used to test if it"s an interval. It accepts intervals\nas pitch or string in shorthand notation or tonal notation. It returns always\nintervals in tonal notation.
\n\n**Kind**: static method of [Interval](#module_Interval) \n**Returns**: string - the interval name or null if not valid interval
\n\n| Param | Type | Description |\n| --- | --- | --- |\n| interval |string | the interval string or array
|\n\n**Example** \n```js\nInterval.name(\"m-3\") // => \"-3m\"\nInterval.name(\"3\") // => null\n```\n\n\n### Interval.name(ivl) ⇒Integer\nGet size in semitones of an interval
\n\n**Kind**: static method of [Interval](#module_Interval) \n**Returns**: Integer - the number of semitones or null if not an interval
\n\n| Param | Type |\n| --- | --- |\n| ivl |string | \n\n**Example** \n```js\nimport { semitones } from \"tonal-interval\"\nsemitones(\"P4\") // => 5\n// or using tonal\nTonal.Interval.semitones(\"P5\") // => 7\n```\n\n\n### Interval.semitones(str) ⇒ Number\nGet the chroma of the interval. The chroma is a number between 0 and 7\nthat represents the position within an octave (pitch set)
\n\n**Kind**: static method of [Interval](#module_Interval) \n\n| Param | Type |\n| --- | --- |\n| str | string | \n\n\n\n### Interval.chroma(interval) ⇒ Integer\nGet the interval class\nnumber of a given interval.
\nIn musical set theory, an interval class is the shortest distance in\npitch class space between two unordered pitch classes
\n\n**Kind**: static method of [Interval](#module_Interval) \n**Returns**: Integer - A value between 0 and 6
\n\n| Param | Type | Description |\n| --- | --- | --- |\n| interval |String \\| Integer | the interval or the number of semitones
|\n\n**Example** \n```js\nInterval.ic(\"P8\") // => 0\nInterval.ic(\"m6\") // => 4\nInterval.ic(10) // => 2\n[\"P1\", \"M2\", \"M3\", \"P4\", \"P5\", \"M6\", \"M7\"].map(ic) // => [0, 2, 4, 5, 5, 3, 1]\n```\n\n\n### Interval.ic(props) ⇒string\nGiven a interval property object, get the interval name
\nThe properties must contain a num or step, and alt:
Interval](#module_Interval) \n**Returns**: string - the interval name
\n\n| Param | Type | Description |\n| --- | --- | --- |\n| props |Object | the interval property object
|\n\n**Example** \n```js\nInterval.build({ step: 1, alt: -1, oct: 0, dir: 1 }) // => \"1d\"\nInterval.build({ num: 9, alt: -1 }) // => \"9m\"\n```\n\n\n### Interval.build(interval) ⇒string\nGet the simplified version of an interval.
\n\n**Kind**: static method of [Interval](#module_Interval) \n**Returns**: string - the simplified interval
\n\n| Param | Type | Description |\n| --- | --- | --- |\n| interval |string | the interval to simplify
|\n\n**Example** \n```js\nInterval.simplify(\"9M\") // => \"2M\"\n[\"8P\", \"9M\", \"10M\", \"11P\", \"12P\", \"13M\", \"14M\", \"15P\"].map(Interval.simplify)\n// => [ \"8P\", \"2M\", \"3M\", \"4P\", \"5P\", \"6M\", \"7M\", \"8P\" ]\nInterval.simplify(\"2M\") // => \"2M\"\nInterval.simplify(\"-2M\") // => \"7m\"\n```\n\n\n### Interval.simplify(interval) ⇒string\nGet the inversion (https://en.wikipedia.org/wiki/Inversion_(music)#Intervals)\nof an interval.
\n\n**Kind**: static method of [Interval](#module_Interval) \n**Returns**: string - the inverted interval
\n\n| Param | Type | Description |\n| --- | --- | --- |\n| interval |string | the interval to invert in interval shorthand notation or interval array notation
|\n\n**Example** \n```js\nInterval.invert(\"3m\") // => \"6M\"\nInterval.invert(\"2M\") // => \"7m\"\n```\n\n\n### Interval~names(qualities) ⇒Array\nList basic (perfect, major, minor) interval names within a octave
\n\n**Kind**: inner method of [Interval](#module_Interval) \n**Returns**: Array - the interval names
\n\n| Param | Type | Description |\n| --- | --- | --- |\n| qualities |string | (Optional, default "PMm") the valid types
|\n\n**Example** \n```js\nInterval.names() // => [ \"1P\", \"2m\", \"2M\", \"3m\", \"3M\", \"4P\", \"5P\", \"6m\", \"6M\", \"7m\", \"7M\", \"8P\" ]\nInterval.names(\"P\") // => [ \"1P\", \"4P\", \"5P\", \"8P\" ]\nInterval.names(\"PM\") // => [ \"1P\", \"2M\", \"3M\", \"4P\", \"5P\", \"6M\", \"7M\", \"8P\" ]\nInterval.names(\"Pm\") // => [ \"1P\", \"2m\", \"3m\", \"4P\", \"5P\", \"6m\", \"7m\", \"8P\" ]\nInterval.names(\"d\") // => []\n```\n\n\n### Interval~props(interval) ⇒Object\nGet interval properties. It returns an object with:
\nInterval](#module_Interval) \n**Returns**: Object - the interval in the form [number, alt]
\n\n| Param | Type | Description |\n| --- | --- | --- |\n| interval |string | the interval
|\n\n\n\n### Interval~num(interval) ⇒Integer\nGet the number of the interval
\n\n**Kind**: inner method of [Interval](#module_Interval) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| interval | string | the interval
|\n\n**Example** \n```js\nInterval.num(\"m2\") // => 2\nInterval.num(\"P9\") // => 9\nInterval.num(\"P-4\") // => -4\n```\n\n\n### Interval~fromSemitones(num) ⇒string\nGet interval name from semitones number. Since there are several interval\nnames for the same number, the name it"s arbitraty, but deterministic.
\n\n**Kind**: inner method of [Interval](#module_Interval) \n**Returns**: string - the interval name
\n\n| Param | Type | Description |\n| --- | --- | --- |\n| num |Integer | the number of semitones (can be negative)
|\n\n**Example** \n```js\nimport { fromSemitones } from \"tonal-interval\"\nfromSemitones(7) // => \"5P\"\n// or using tonal\nTonal.Distance.fromSemitones(-7) // => \"-5P\"\n```\n","maintainers":[{"name":"danigb","email":"danigb@gmail.com"}],"time":{"modified":"2022-06-27T18:17:35.396Z","created":"2016-05-08T07:17:51.354Z","0.50.0":"2016-05-08T07:17:51.354Z","0.50.1":"2016-05-08T11:36:10.289Z","0.60.0":"2016-11-15T15:07:52.674Z","0.61.0":"2016-11-16T00:43:58.551Z","0.64.0":"2016-11-16T11:29:56.546Z","0.65.0":"2016-11-17T18:28:35.426Z","0.66.0":"2016-11-20T18:50:12.490Z","0.68.1":"2017-01-31T09:25:42.780Z","0.69.0":"2017-02-16T23:04:38.955Z","0.69.2":"2017-04-04T20:50:32.461Z","0.69.3":"2017-04-04T21:10:13.878Z","0.69.4":"2017-04-04T21:49:05.282Z","0.69.6":"2017-05-05T17:22:19.121Z","0.69.7":"2017-07-08T10:51:41.876Z","0.69.8":"2017-08-06T16:08:10.230Z","0.69.9":"2017-08-06T16:09:47.332Z","1.0.0-0":"2017-09-26T21:50:34.840Z","1.0.0-1":"2017-09-29T07:31:37.947Z","1.0.0-pre2":"2017-09-29T09:04:37.120Z","1.0.0-pre3":"2017-09-29T09:22:05.517Z","1.0.0-pre4":"2017-10-01T10:11:09.503Z","1.0.0-pre5":"2017-10-01T16:29:02.993Z","1.0.0-pre6":"2017-10-03T23:52:06.481Z","1.0.0":"2017-10-04T15:23:32.123Z","1.1.0":"2017-10-24T22:32:26.309Z","1.1.2":"2018-01-04T22:24:54.964Z","2.0.0":"2018-09-11T15:55:47.665Z","2.1.0":"2018-11-04T14:46:10.409Z","2.1.2":"2018-11-15T05:58:39.503Z","2.2.0":"2019-02-14T23:23:43.583Z","2.2.1":"2019-02-15T00:17:49.179Z","2.2.2":"2019-04-03T19:58:33.248Z"},"keywords":["music","theory","interval","tonal"],"author":{"name":"danigb"},"license":"MIT","readmeFilename":"README.md","users":{"rchk":true},"repository":{"type":"git","url":"https://github.com/danigb/tonal/packages/interval"}}