chordsheetjs 7.6.0 → 7.7.0

package/README.md

@@ -398,6 +398,9 @@ Inherits from [ChordSheetParser](#ChordSheetParser)</p></dd>
 <dd><p>Represents a Chord, consisting of a root, suffix (quality) and bass</p></dd>
 <dt><a href="#ChordSheetSerializer">ChordSheetSerializer</a></dt>
 <dd><p>Serializes a song into een plain object, and deserializes the serialized object back into a [Song](#Song)</p></dd>
+<dt><a href="#Key">Key</a></dt>
+<dd><p>Represents a key, such as Eb (symbol), #3 (numeric) or VII (numeral).</p>
+<p>The only function considered public API is <code>Key.distance</code></p></dd>
 </dl>
 
 ## Members
@@ -1228,7 +1231,7 @@ When the chord is already a chord symbol, it will return a clone of the object.<
 
 | Param | Type | Default | Description |
 | --- | --- | --- | --- |
-| [key] | <code>Key</code> \| <code>string</code> | <code></code> | <p>the reference key</p> |
+| [key] | [<code>Key</code>](#Key) \| <code>string</code> | <code></code> | <p>the reference key</p> |
 
 <a name="Chord+toChordSymbolString"></a>
 
@@ -1243,7 +1246,7 @@ When the chord is already a chord symbol, it will return a string version of the
 
 | Param | Type | Default | Description |
 | --- | --- | --- | --- |
-| [key] | <code>Key</code> \| <code>string</code> | <code></code> | <p>the reference key</p> |
+| [key] | [<code>Key</code>](#Key) \| <code>string</code> | <code></code> | <p>the reference key</p> |
 
 <a name="Chord+isChordSymbol"></a>
 
@@ -1262,7 +1265,7 @@ For example, a chord symbol A# with reference key E will return the numeric chor
 
 | Param | Type | Default | Description |
 | --- | --- | --- | --- |
-| [key] | <code>Key</code> \| <code>string</code> | <code></code> | <p>the reference key</p> |
+| [key] | [<code>Key</code>](#Key) \| <code>string</code> | <code></code> | <p>the reference key</p> |
 
 <a name="Chord+toNumeral"></a>
 
@@ -1275,7 +1278,7 @@ For example, a chord symbol A# with reference key E will return the numeral chor
 
 | Param | Type | Default | Description |
 | --- | --- | --- | --- |
-| key | <code>Key</code> \| <code>string</code> \| <code>null</code> | <code></code> | <p>the reference key. The key is required when converting a chord symbol</p> |
+| key | [<code>Key</code>](#Key) \| <code>string</code> \| <code>null</code> | <code></code> | <p>the reference key. The key is required when converting a chord symbol</p> |
 
 <a name="Chord+toNumeralString"></a>
 
@@ -1289,7 +1292,7 @@ For example, a chord symbol A# with reference key E will return the numeral chor
 
 | Param | Type | Default | Description |
 | --- | --- | --- | --- |
-| [key] | <code>Key</code> \| <code>string</code> | <code></code> | <p>the reference key</p> |
+| [key] | [<code>Key</code>](#Key) \| <code>string</code> | <code></code> | <p>the reference key</p> |
 
 <a name="Chord+isNumeric"></a>
 
@@ -1309,7 +1312,7 @@ For example, a chord symbol A# with reference key E will return the numeric chor
 
 | Param | Type | Default | Description |
 | --- | --- | --- | --- |
-| [key] | <code>Key</code> \| <code>string</code> | <code></code> | <p>the reference key</p> |
+| [key] | [<code>Key</code>](#Key) \| <code>string</code> | <code></code> | <p>the reference key</p> |
 
 <a name="Chord+isNumeral"></a>
 
@@ -1347,7 +1350,7 @@ All suffix normalizations can be found in <code>src/normalize_mappings/suffix-ma
 
 | Param | Type | Default | Description |
 | --- | --- | --- | --- |
-| [key] | <code>Key</code> \| <code>string</code> | <code></code> | <p>the key to normalize to</p> |
+| [key] | [<code>Key</code>](#Key) \| <code>string</code> | <code></code> | <p>the key to normalize to</p> |
 | [options] | <code>Object</code> | <code>{}</code> | <p>options</p> |
 | [options.normalizeSuffix] | <code>boolean</code> | <code>true</code> | <p>whether to normalize the chord suffix after transposing</p> |
 
@@ -1431,6 +1434,26 @@ Can be deserialized using [deserialize](deserialize)</p>
 | --- | --- | --- |
 | serializedSong | <code>object</code> | <p>The serialized song</p> |
 
+<a name="Key"></a>
+
+## Key
+<p>Represents a key, such as Eb (symbol), #3 (numeric) or VII (numeral).</p>
+<p>The only function considered public API is <code>Key.distance</code></p>
+
+**Kind**: global class  
+<a name="Key.distance"></a>
+
+### Key.distance(oneKey, otherKey) ⇒ <code>number</code>
+<p>Calculates the distance in semitones between one key and another.</p>
+
+**Kind**: static method of [<code>Key</code>](#Key)  
+**Returns**: <code>number</code> - <p>the distance in semitones</p>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| oneKey | [<code>Key</code>](#Key) \| <code>string</code> | <p>the key</p> |
+| otherKey | [<code>Key</code>](#Key) \| <code>string</code> | <p>the other key</p> |
+
 <a name="ALBUM"></a>
 
 ## ALBUM : <code>string</code>
@@ -1637,7 +1660,7 @@ values are the effective key for that capo.</p>
 
 | Param | Type | Description |
 | --- | --- | --- |
-| key | <code>Key</code> \| <code>string</code> | <p>The key to get capos for</p> |
+| key | [<code>Key</code>](#Key) \| <code>string</code> | <p>The key to get capos for</p> |
 
 <a name="getKeys"></a>
 
@@ -1649,5 +1672,5 @@ values are the effective key for that capo.</p>
 
 | Param | Type | Description |
 | --- | --- | --- |
-| key | <code>Key</code> \| <code>string</code> | <p>The key to get keys for</p> |
+| key | [<code>Key</code>](#Key) \| <code>string</code> | <p>The key to get keys for</p> |