tonal-interval - npm Package Compare versions

Comparing version 0.69.7 to 0.69.8

package.json

 {
   "name": "tonal-interval",
-  "version": "0.69.7",
+  "version": "0.69.8",
   "description": "Music interval creation and manipulation",
@@ -5,0 +5,0 @@ "repository": "https://github.com/danigb/tonal/packages/interval",

README.md

@@ -48,4 +48,4 @@ <a name="module_interval"></a>
     * [`.type(interval)`](#module_interval.type) ⇒ <code>String</code>
-    * [`.invert(interval)`](#module_interval.invert) ⇒ <code>String</code> &#124; <code>Pitch</code>
-    * [`.simplify(interval)`](#module_interval.simplify) ⇒ <code>String</code> &#124; <code>Array</code>
+    * [`.invert(interval)`](#module_interval.invert) ⇒ <code>String</code> \| <code>Pitch</code>
+    * [`.simplify(interval)`](#module_interval.simplify) ⇒ <code>String</code> \| <code>Array</code>
 
@@ -59,3 +59,3 @@ <a name="module_interval.toInterval"></a>
 
-**Kind**: static method of <code>[interval](#module_interval)</code>  
+**Kind**: static method of [<code>interval</code>](#module_interval)  
 **Returns**: <code>String</code> - the interval name or null if not valid interval  
@@ -65,3 +65,3 @@
 | --- | --- | --- |
-| interval | <code>String</code> &#124; <code>Pitch</code> | the interval string or array |
+| interval | <code>String</code> \| <code>Pitch</code> | the interval string or array |
 
@@ -78,3 +78,3 @@ **Example**
 
-**Kind**: static method of <code>[interval](#module_interval)</code>  
+**Kind**: static method of [<code>interval</code>](#module_interval)  
 **Returns**: <code>Integer</code> - the positive interval number (P1 is 1, m2 is 2, ...)  
@@ -84,3 +84,3 @@
 | --- | --- | --- |
-| interval | <code>String</code> &#124; <code>Pitch</code> | the interval |
+| interval | <code>String</code> \| <code>Pitch</code> | the interval |
 
@@ -99,3 +99,3 @@ **Example**
 
-**Kind**: static method of <code>[interval](#module_interval)</code>  
+**Kind**: static method of [<code>interval</code>](#module_interval)  
 **Returns**: <code>Integer</code> - the positive interval number (P1 is 1, m-2 is -2, ...)  
@@ -105,3 +105,3 @@
 | --- | --- | --- |
-| interval | <code>String</code> &#124; <code>Pitch</code> | the interval |
+| interval | <code>String</code> \| <code>Pitch</code> | the interval |
 
@@ -124,3 +124,3 @@ **Example**
 
-**Kind**: static method of <code>[interval](#module_interval)</code>  
+**Kind**: static method of [<code>interval</code>](#module_interval)  
 **Returns**: <code>Array</code> - the interval in the form [number, alt]  
@@ -130,3 +130,3 @@
 | --- | --- | --- |
-| interval | <code>String</code> &#124; <code>Pitch</code> | the interval |
+| interval | <code>String</code> \| <code>Pitch</code> | the interval |
 
@@ -145,3 +145,3 @@ **Example**
 
-**Kind**: static method of <code>[interval](#module_interval)</code>  
+**Kind**: static method of [<code>interval</code>](#module_interval)  
 **Returns**: <code>String</code> - the interval name  
@@ -158,3 +158,3 @@
 
-**Kind**: static method of <code>[interval](#module_interval)</code>  
+**Kind**: static method of [<code>interval</code>](#module_interval)  
 **Returns**: <code>Integer</code> - the number of semitones or null if not an interval  
@@ -164,3 +164,3 @@
 | --- | --- |
-| ivl | <code>String</code> &#124; <code>Pitch</code> | 
+| ivl | <code>String</code> \| <code>Pitch</code> | 
 
@@ -180,3 +180,3 @@ **Example**
 
-**Kind**: static method of <code>[interval](#module_interval)</code>  
+**Kind**: static method of [<code>interval</code>](#module_interval)  
 **Returns**: <code>String</code> - the interval name  
@@ -207,3 +207,3 @@
 
-**Kind**: static method of <code>[interval](#module_interval)</code>  
+**Kind**: static method of [<code>interval</code>](#module_interval)  
 **Returns**: <code>Integer</code> - A value between 0 and 6  
@@ -213,3 +213,3 @@
 | --- | --- | --- |
-| interval | <code>String</code> &#124; <code>Integer</code> | the interval or the number of semitones |
+| interval | <code>String</code> \| <code>Integer</code> | the interval or the number of semitones |
 
@@ -228,3 +228,3 @@ **Example**
 
-**Kind**: static method of <code>[interval](#module_interval)</code>  
+**Kind**: static method of [<code>interval</code>](#module_interval)  
 **Returns**: <code>String</code> - 'P' for perfectables, 'M' for majorables or null if not
@@ -235,3 +235,3 @@ valid interval
 | --- | --- |
-| interval | <code>String</code> &#124; <code>Pitch</code> | 
+| interval | <code>String</code> \| <code>Pitch</code> | 
 
@@ -244,12 +244,12 @@ **Example**
 
-## `interval.invert(interval)` ⇒ <code>String</code> &#124; <code>Pitch</code>
+## `interval.invert(interval)` ⇒ <code>String</code> \| <code>Pitch</code>
 Get the inversion (https://en.wikipedia.org/wiki/Inversion_(music)#Intervals)
 of an interval.
 
-**Kind**: static method of <code>[interval](#module_interval)</code>  
-**Returns**: <code>String</code> &#124; <code>Pitch</code> - the inverted interval  
+**Kind**: static method of [<code>interval</code>](#module_interval)  
+**Returns**: <code>String</code> \| <code>Pitch</code> - the inverted interval  
 
 | Param | Type | Description |
 | --- | --- | --- |
-| interval | <code>String</code> &#124; <code>Pitch</code> | the interval to invert in interval shorthand notation or interval array notation |
+| interval | <code>String</code> \| <code>Pitch</code> | the interval to invert in interval shorthand notation or interval array notation |
 
@@ -263,11 +263,11 @@ **Example**
 
-## `interval.simplify(interval)` ⇒ <code>String</code> &#124; <code>Array</code>
+## `interval.simplify(interval)` ⇒ <code>String</code> \| <code>Array</code>
 Get the simplified version of an interval.
 
-**Kind**: static method of <code>[interval](#module_interval)</code>  
-**Returns**: <code>String</code> &#124; <code>Array</code> - the simplified interval  
+**Kind**: static method of [<code>interval</code>](#module_interval)  
+**Returns**: <code>String</code> \| <code>Array</code> - the simplified interval  
 
 | Param | Type | Description |
 | --- | --- | --- |
-| interval | <code>String</code> &#124; <code>Array</code> | the interval to simplify |
+| interval | <code>String</code> \| <code>Array</code> | the interval to simplify |
 
@@ -274,0 +274,0 @@ **Example**

No alert changes

Worsened metrics

Total package byte prevSize

31154

decreased by-0.19%

No dependency changes