tonal-interval
Advanced tools
Comparing version 1.1.0 to 1.1.2
@@ -32,3 +32,3 @@ 'use strict'; | ||
* import { Interval } from "tonal" | ||
* | ||
* | ||
* Interval.semitones("4P") // => 5 | ||
@@ -58,3 +58,3 @@ * Interval.invert("3m") // => "6M" | ||
/** | ||
* List basic (perfect, major, minor) interval names within a octave | ||
* List basic (perfect, major, minor) interval names within a octave | ||
* @param {String} qualities - (Optional, default "PMm") the valid types | ||
@@ -137,3 +137,3 @@ * @return {Array} the interval names | ||
* - q: quality | ||
* - step: step | ||
* - step: step | ||
* - alt: alteration | ||
@@ -157,7 +157,7 @@ * - dir: direction (1 ascending, -1 descending) | ||
/** | ||
* Get the number of the interval | ||
* Get the number of the interval | ||
* | ||
* @function | ||
* @param {String} interval - the interval | ||
* @return {Integer} | ||
* @return {Integer} | ||
* @example | ||
@@ -186,3 +186,3 @@ * Interval.num("m2") // => 2 | ||
* Get size in semitones of an interval | ||
* | ||
* | ||
* @function | ||
@@ -202,5 +202,5 @@ * @param {String} ivl | ||
* that represents the position within an octave (pitch set) | ||
* | ||
* | ||
* @function | ||
* @param {String} str | ||
* @param {String} str | ||
* @return {Number} | ||
@@ -236,3 +236,3 @@ */ | ||
* The properties must contain a `num` *or* `step`, and `alt`: | ||
* | ||
* | ||
* - num: the interval number | ||
@@ -243,3 +243,3 @@ * - step: the interval step (overrides the num property) | ||
* - dir: (Optional) the direction | ||
* | ||
* | ||
* @function | ||
@@ -318,3 +318,3 @@ * @param {Object} props - the interval property object | ||
* names for the same number, the name it"s arbitraty, but deterministic. | ||
* | ||
* | ||
* @function | ||
@@ -321,0 +321,0 @@ * @param {Integer} num - the number of semitones (can be negative) |
@@ -28,3 +28,3 @@ /** | ||
* import { Interval } from "tonal" | ||
* | ||
* | ||
* Interval.semitones("4P") // => 5 | ||
@@ -54,3 +54,3 @@ * Interval.invert("3m") // => "6M" | ||
/** | ||
* List basic (perfect, major, minor) interval names within a octave | ||
* List basic (perfect, major, minor) interval names within a octave | ||
* @param {String} qualities - (Optional, default "PMm") the valid types | ||
@@ -133,3 +133,3 @@ * @return {Array} the interval names | ||
* - q: quality | ||
* - step: step | ||
* - step: step | ||
* - alt: alteration | ||
@@ -153,7 +153,7 @@ * - dir: direction (1 ascending, -1 descending) | ||
/** | ||
* Get the number of the interval | ||
* Get the number of the interval | ||
* | ||
* @function | ||
* @param {String} interval - the interval | ||
* @return {Integer} | ||
* @return {Integer} | ||
* @example | ||
@@ -182,3 +182,3 @@ * Interval.num("m2") // => 2 | ||
* Get size in semitones of an interval | ||
* | ||
* | ||
* @function | ||
@@ -198,5 +198,5 @@ * @param {String} ivl | ||
* that represents the position within an octave (pitch set) | ||
* | ||
* | ||
* @function | ||
* @param {String} str | ||
* @param {String} str | ||
* @return {Number} | ||
@@ -232,3 +232,3 @@ */ | ||
* The properties must contain a `num` *or* `step`, and `alt`: | ||
* | ||
* | ||
* - num: the interval number | ||
@@ -239,3 +239,3 @@ * - step: the interval step (overrides the num property) | ||
* - dir: (Optional) the direction | ||
* | ||
* | ||
* @function | ||
@@ -314,3 +314,3 @@ * @param {Object} props - the interval property object | ||
* names for the same number, the name it"s arbitraty, but deterministic. | ||
* | ||
* | ||
* @function | ||
@@ -317,0 +317,0 @@ * @param {Integer} num - the number of semitones (can be negative) |
22
index.js
@@ -28,3 +28,3 @@ /** | ||
* import { Interval } from "tonal" | ||
* | ||
* | ||
* Interval.semitones("4P") // => 5 | ||
@@ -54,3 +54,3 @@ * Interval.invert("3m") // => "6M" | ||
/** | ||
* List basic (perfect, major, minor) interval names within a octave | ||
* List basic (perfect, major, minor) interval names within a octave | ||
* @param {String} qualities - (Optional, default "PMm") the valid types | ||
@@ -134,3 +134,3 @@ * @return {Array} the interval names | ||
* - q: quality | ||
* - step: step | ||
* - step: step | ||
* - alt: alteration | ||
@@ -154,7 +154,7 @@ * - dir: direction (1 ascending, -1 descending) | ||
/** | ||
* Get the number of the interval | ||
* Get the number of the interval | ||
* | ||
* @function | ||
* @param {String} interval - the interval | ||
* @return {Integer} | ||
* @return {Integer} | ||
* @example | ||
@@ -183,3 +183,3 @@ * Interval.num("m2") // => 2 | ||
* Get size in semitones of an interval | ||
* | ||
* | ||
* @function | ||
@@ -199,5 +199,5 @@ * @param {String} ivl | ||
* that represents the position within an octave (pitch set) | ||
* | ||
* | ||
* @function | ||
* @param {String} str | ||
* @param {String} str | ||
* @return {Number} | ||
@@ -233,3 +233,3 @@ */ | ||
* The properties must contain a `num` *or* `step`, and `alt`: | ||
* | ||
* | ||
* - num: the interval number | ||
@@ -240,3 +240,3 @@ * - step: the interval step (overrides the num property) | ||
* - dir: (Optional) the direction | ||
* | ||
* | ||
* @function | ||
@@ -308,3 +308,3 @@ * @param {Object} props - the interval property object | ||
* names for the same number, the name it"s arbitraty, but deterministic. | ||
* | ||
* | ||
* @function | ||
@@ -311,0 +311,0 @@ * @param {Integer} num - the number of semitones (can be negative) |
{ | ||
"name": "tonal-interval", | ||
"version": "1.1.0", | ||
"version": "1.1.2", | ||
"description": "Music interval creation and manipulation", | ||
@@ -5,0 +5,0 @@ "repository": "https://github.com/danigb/tonal/packages/interval", |
@@ -84,3 +84,3 @@ <a name="module_Interval"></a> | ||
- q: quality | ||
- step: step | ||
- step: step | ||
- alt: alteration | ||
@@ -87,0 +87,0 @@ - dir: direction (1 ascending, -1 descending) |
46823