chordsheetjs 4.10.0 → 5.2.0

package/README.md

@@ -1,4 +1,4 @@
-# ChordSheetJS ![example branch parameter](https://github.com/martijnversluis/ChordSheetJS/actions/workflows/ci.yml/badge.svg?branch=master) [![npm version](https://badge.fury.io/js/chordsheetjs.svg)](https://badge.fury.io/js/chordsheetjs) [![Code Climate](https://codeclimate.com/github/martijnversluis/ChordSheetJS/badges/gpa.svg)](https://codeclimate.com/github/martijnversluis/ChordSheetJS)
+# ChordSheetJS [![Build Status](https://travis-ci.org/martijnversluis/ChordSheetJS.svg?branch=master)](https://travis-ci.org/martijnversluis/ChordSheetJS) [![npm version](https://badge.fury.io/js/chordsheetjs.svg)](https://badge.fury.io/js/chordsheetjs) [![Code Climate](https://codeclimate.com/github/martijnversluis/ChordSheetJS/badges/gpa.svg)](https://codeclimate.com/github/martijnversluis/ChordSheetJS)
 
 A JavaScript library for parsing and formatting chord sheets
 
@@ -396,17 +396,11 @@ PDF conversion.</p>
 Inherits from <a href="#ChordSheetParser">ChordSheetParser</a></p>
 </dd>
 <dt><a href="#Chord">Chord</a></dt>
-<dd><p>Base class for <a href="#ChordSymbol">ChordSymbol</a> and <a href="#NumericChord">NumericChord</a></p>
+<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 <a href="#Song">Song</a></p>
 </dd>
-<dt><a href="#ChordSymbol">ChordSymbol</a></dt>
-<dd><p>Represents a chord symbol, such as Esus4</p>
-</dd>
-<dt><a href="#NumericChord">NumericChord</a></dt>
-<dd><p>Represents a numeric chord, such as b3sus4</p>
-</dd>
 </dl>
 
 ## Constants
@@ -436,6 +430,9 @@ Inherits from <a href="#ChordSheetParser">ChordSheetParser</a></p>
 <dt><a href="#END_OF_CHORUS">END_OF_CHORUS</a> : <code>string</code></dt>
 <dd><p>End of chorus directive. See <a href="https://www.chordpro.org/chordpro/directives-env_chorus/">https://www.chordpro.org/chordpro/directives-env_chorus/</a></p>
 </dd>
+<dt><a href="#END_OF_TAB">END_OF_TAB</a> : <code>string</code></dt>
+<dd><p>End of tab directive. See <a href="https://www.chordpro.org/chordpro/directives-env_tab/">https://www.chordpro.org/chordpro/directives-env_tab/</a></p>
+</dd>
 <dt><a href="#END_OF_VERSE">END_OF_VERSE</a> : <code>string</code></dt>
 <dd><p>End of verse directive. See <a href="https://www.chordpro.org/chordpro/directives-env_verse/">https://www.chordpro.org/chordpro/directives-env_verse/</a></p>
 </dd>
@@ -451,6 +448,9 @@ Inherits from <a href="#ChordSheetParser">ChordSheetParser</a></p>
 <dt><a href="#START_OF_CHORUS">START_OF_CHORUS</a> : <code>string</code></dt>
 <dd><p>Start of chorus directive. See <a href="https://www.chordpro.org/chordpro/directives-env_chorus/">https://www.chordpro.org/chordpro/directives-env_chorus/</a></p>
 </dd>
+<dt><a href="#START_OF_TAB">START_OF_TAB</a> : <code>string</code></dt>
+<dd><p>Start of tab directive. See <a href="https://www.chordpro.org/chordpro/directives-env_tab/">https://www.chordpro.org/chordpro/directives-env_tab/</a></p>
+</dd>
 <dt><a href="#START_OF_VERSE">START_OF_VERSE</a> : <code>string</code></dt>
 <dd><p>Start of verse directive. See <a href="https://www.chordpro.org/chordpro/directives-env_verse/">https://www.chordpro.org/chordpro/directives-env_verse/</a></p>
 </dd>
@@ -485,6 +485,9 @@ For a CSS string see <a href="#scopedCss">scopedCss</a></p>
 <dt><a href="#INDETERMINATE">INDETERMINATE</a> : <code>string</code></dt>
 <dd><p>Used to mark a paragraph as containing lines with both verse and chorus type</p>
 </dd>
+<dt><a href="#TAB">TAB</a> : <code>string</code></dt>
+<dd><p>Used to mark a paragraph as tab</p>
+</dd>
 </dl>
 
 ## Functions
@@ -493,12 +496,9 @@ For a CSS string see <a href="#scopedCss">scopedCss</a></p>
 <dt><a href="#scopedCss">scopedCss(scope)</a> ⇒ <code>string</code></dt>
 <dd><p>Generates basic CSS, scoped within the provided selector, to use with output generated by <a href="#HtmlTableFormatter">HtmlTableFormatter</a></p>
 </dd>
-<dt><a href="#parseChord">parseChord(chordString)</a> ⇒ <code>null</code> | <code><a href="#ChordSymbol">ChordSymbol</a></code> | <code><a href="#NumericChord">NumericChord</a></code></dt>
+<dt><del><a href="#parseChord">parseChord(chordString)</a> ⇒ <code>null</code> | <code><a href="#Chord">Chord</a></code></del></dt>
 <dd><p>Tries to parse a chord string into a chord</p>
 </dd>
-<dt><a href="#toChordSymbol">toChordSymbol(numericChord, key)</a> ⇒ <code><a href="#ChordSymbol">ChordSymbol</a></code></dt>
-<dd><p>Converts a numeric chord into a chord symbol, using the provided key</p>
-</dd>
 </dl>
 
 <a name="ChordLyricsPair"></a>
@@ -1165,186 +1165,205 @@ Inherits from [ChordSheetParser](#ChordSheetParser)
 <a name="Chord"></a>
 
 ## Chord
-Base class for [ChordSymbol](#ChordSymbol) and [NumericChord](#NumericChord)
+Represents a Chord, consisting of a root, suffix (quality) and bass
 
 **Kind**: global class  
+
+* [Chord](#Chord)
+    * _instance_
+        * [.clone()](#Chord+clone) ⇒ [<code>Chord</code>](#Chord)
+        * [.toChordSymbol(key)](#Chord+toChordSymbol) ⇒ [<code>Chord</code>](#Chord)
+        * [.toChordSymbolString(key)](#Chord+toChordSymbolString) ⇒ <code>string</code>
+        * [.isChordSymbol()](#Chord+isChordSymbol) ⇒ <code>boolean</code>
+        * [.toNumeric(key)](#Chord+toNumeric) ⇒ [<code>Chord</code>](#Chord)
+        * [.isNumeric()](#Chord+isNumeric) ⇒ <code>boolean</code>
+        * [.toNumericString(key)](#Chord+toNumericString) ⇒ <code>string</code>
+        * [.toString()](#Chord+toString) ⇒ <code>string</code>
+        * [.normalize()](#Chord+normalize) ⇒ [<code>Chord</code>](#Chord)
+        * [.useModifier(newModifier)](#Chord+useModifier) ⇒ [<code>Chord</code>](#Chord)
+        * [.transposeUp()](#Chord+transposeUp) ⇒ [<code>Chord</code>](#Chord)
+        * [.transposeDown()](#Chord+transposeDown) ⇒ [<code>Chord</code>](#Chord)
+        * [.transpose(delta)](#Chord+transpose) ⇒ [<code>Chord</code>](#Chord)
+    * _static_
+        * [.parse(chordString)](#Chord.parse) ⇒ <code>null</code> \| [<code>Chord</code>](#Chord)
+
 <a name="Chord+clone"></a>
 
 ### chord.clone() ⇒ [<code>Chord</code>](#Chord)
 Returns a deep copy of the chord
 
 **Kind**: instance method of [<code>Chord</code>](#Chord)  
-<a name="ChordSheetSerializer"></a>
+<a name="Chord+toChordSymbol"></a>
 
-## ChordSheetSerializer
-Serializes a song into een plain object, and deserializes the serialized object back into a [Song](#Song)
+### chord.toChordSymbol(key) ⇒ [<code>Chord</code>](#Chord)
+Converts the chord to a chord symbol, using the supplied key as a reference.
+For example, a numeric chord `#4` with reference key `E` will return the chord symbol `A#`.
+When the chord is already a chord symbol, it will return a clone of the object.
 
-**Kind**: global class  
+**Kind**: instance method of [<code>Chord</code>](#Chord)  
+**Returns**: [<code>Chord</code>](#Chord) - the chord symbol  
 
-* [ChordSheetSerializer](#ChordSheetSerializer)
-    * [.serialize()](#ChordSheetSerializer+serialize) ⇒
-    * [.deserialize(serializedSong)](#ChordSheetSerializer+deserialize) ⇒ [<code>Song</code>](#Song)
+| Param | Type | Description |
+| --- | --- | --- |
+| key | <code>Key</code> \| <code>string</code> | the reference key |
 
-<a name="ChordSheetSerializer+serialize"></a>
+<a name="Chord+toChordSymbolString"></a>
 
-### chordSheetSerializer.serialize() ⇒
-Serializes the chord sheet to a plain object, which can be converted to any format like JSON, XML etc
-Can be deserialized using [deserialize](deserialize)
+### chord.toChordSymbolString(key) ⇒ <code>string</code>
+Converts the chord to a chord symbol string, using the supplied key as a reference.
+For example, a numeric chord `#4` with reference key `E` will return the chord symbol `A#`.
+When the chord is already a chord symbol, it will return a string version of the chord.
 
-**Kind**: instance method of [<code>ChordSheetSerializer</code>](#ChordSheetSerializer)  
-**Returns**: object A plain JS object containing all chord sheet data  
-<a name="ChordSheetSerializer+deserialize"></a>
+**Kind**: instance method of [<code>Chord</code>](#Chord)  
+**Returns**: <code>string</code> - the chord symbol string  
+**See**: {toChordSymbol}  
 
-### chordSheetSerializer.deserialize(serializedSong) ⇒ [<code>Song</code>](#Song)
-Deserializes a song that has been serialized using [serialize](serialize)
+| Param | Type | Description |
+| --- | --- | --- |
+| key | <code>Key</code> \| <code>string</code> | the reference key |
 
-**Kind**: instance method of [<code>ChordSheetSerializer</code>](#ChordSheetSerializer)  
-**Returns**: [<code>Song</code>](#Song) - The deserialized song  
+<a name="Chord+isChordSymbol"></a>
+
+### chord.isChordSymbol() ⇒ <code>boolean</code>
+Determines whether the chord is a chord symbol
+
+**Kind**: instance method of [<code>Chord</code>](#Chord)  
+<a name="Chord+toNumeric"></a>
+
+### chord.toNumeric(key) ⇒ [<code>Chord</code>](#Chord)
+Converts the chord to a numeric chord, using the supplied kye as a reference.
+For example, a chord symbol A# with reference key E will return the numeric chord #4.
+
+**Kind**: instance method of [<code>Chord</code>](#Chord)  
+**Returns**: [<code>Chord</code>](#Chord) - the numeric chord  
 
 | Param | Type | Description |
 | --- | --- | --- |
-| serializedSong | <code>object</code> | The serialized song |
+| key | <code>Key</code> \| <code>string</code> | the reference key |
 
-<a name="ChordSymbol"></a>
+<a name="Chord+isNumeric"></a>
 
-## ChordSymbol
-Represents a chord symbol, such as Esus4
+### chord.isNumeric() ⇒ <code>boolean</code>
+Determines whether the chord is numeric
 
-**Kind**: global class  
+**Kind**: instance method of [<code>Chord</code>](#Chord)  
+<a name="Chord+toNumericString"></a>
+
+### chord.toNumericString(key) ⇒ <code>string</code>
+Converts the chord to a numeric chord string, using the supplied kye as a reference.
+For example, a chord symbol A# with reference key E will return the numeric chord #4.
+
+**Kind**: instance method of [<code>Chord</code>](#Chord)  
+**Returns**: <code>string</code> - the numeric chord string  
+**See**: {toNumeric}  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| key | <code>Key</code> \| <code>string</code> | the reference key |
 
-* [ChordSymbol](#ChordSymbol)
-    * [.normalize()](#ChordSymbol+normalize) ⇒ [<code>ChordSymbol</code>](#ChordSymbol)
-    * [.switchModifier()](#ChordSymbol+switchModifier) ⇒ [<code>ChordSymbol</code>](#ChordSymbol)
-    * [.useModifier(newModifier)](#ChordSymbol+useModifier) ⇒ [<code>ChordSymbol</code>](#ChordSymbol)
-    * [.transposeUp()](#ChordSymbol+transposeUp) ⇒ [<code>ChordSymbol</code>](#ChordSymbol)
-    * [.transposeDown()](#ChordSymbol+transposeDown) ⇒ [<code>ChordSymbol</code>](#ChordSymbol)
-    * [.transpose(delta)](#ChordSymbol+transpose) ⇒ [<code>ChordSymbol</code>](#ChordSymbol)
-    * [.toString()](#ChordSymbol+toString) ⇒ <code>string</code> \| <code>\*</code>
+<a name="Chord+toString"></a>
 
-<a name="ChordSymbol+normalize"></a>
+### chord.toString() ⇒ <code>string</code>
+Converts the chord to a string, eg `Esus4/G#` or `1sus4/#3`
 
-### chordSymbol.normalize() ⇒ [<code>ChordSymbol</code>](#ChordSymbol)
+**Kind**: instance method of [<code>Chord</code>](#Chord)  
+**Returns**: <code>string</code> - the chord string  
+<a name="Chord+normalize"></a>
+
+### chord.normalize() ⇒ [<code>Chord</code>](#Chord)
 Normalizes the chord:
 - Fb becomes E
 - Cb becomes B
 - B# becomes C
 - E# becomes F
-If the chord is already normalized, this will return a copy.
-
-**Kind**: instance method of [<code>ChordSymbol</code>](#ChordSymbol)  
-**Returns**: [<code>ChordSymbol</code>](#ChordSymbol) - the normalized chord  
-<a name="ChordSymbol+switchModifier"></a>
+- 4b becomes 3
+- 1b becomes 7
+- 7# becomes 1
+- 3# becomes 4
 
-### chordSymbol.switchModifier() ⇒ [<code>ChordSymbol</code>](#ChordSymbol)
-Switches between '#' and 'b' as modifiers. If
+If the chord is already normalized, this will return a copy.
 
-**Kind**: instance method of [<code>ChordSymbol</code>](#ChordSymbol)  
-**Returns**: [<code>ChordSymbol</code>](#ChordSymbol) - the changed chord  
-<a name="ChordSymbol+useModifier"></a>
+**Kind**: instance method of [<code>Chord</code>](#Chord)  
+**Returns**: [<code>Chord</code>](#Chord) - the normalized chord  
+<a name="Chord+useModifier"></a>
 
-### chordSymbol.useModifier(newModifier) ⇒ [<code>ChordSymbol</code>](#ChordSymbol)
+### chord.useModifier(newModifier) ⇒ [<code>Chord</code>](#Chord)
 Switches to the specified modifier
 
-**Kind**: instance method of [<code>ChordSymbol</code>](#ChordSymbol)  
-**Returns**: [<code>ChordSymbol</code>](#ChordSymbol) - the changed chord  
+**Kind**: instance method of [<code>Chord</code>](#Chord)  
+**Returns**: [<code>Chord</code>](#Chord) - the new, changed chord  
 
 | Param | Description |
 | --- | --- |
 | newModifier | the modifier to use: `'#'` or `'b'` |
 
-<a name="ChordSymbol+transposeUp"></a>
+<a name="Chord+transposeUp"></a>
 
-### chordSymbol.transposeUp() ⇒ [<code>ChordSymbol</code>](#ChordSymbol)
+### chord.transposeUp() ⇒ [<code>Chord</code>](#Chord)
 Transposes the chord up by 1 semitone. Eg. A becomes A#, Eb becomes E
 
-**Kind**: instance method of [<code>ChordSymbol</code>](#ChordSymbol)  
-**Returns**: [<code>ChordSymbol</code>](#ChordSymbol) - the transposed chord  
-<a name="ChordSymbol+transposeDown"></a>
+**Kind**: instance method of [<code>Chord</code>](#Chord)  
+**Returns**: [<code>Chord</code>](#Chord) - the new, transposed chord  
+<a name="Chord+transposeDown"></a>
 
-### chordSymbol.transposeDown() ⇒ [<code>ChordSymbol</code>](#ChordSymbol)
+### chord.transposeDown() ⇒ [<code>Chord</code>](#Chord)
 Transposes the chord down by 1 semitone. Eg. A# becomes A, E becomes Eb
 
-**Kind**: instance method of [<code>ChordSymbol</code>](#ChordSymbol)  
-**Returns**: [<code>ChordSymbol</code>](#ChordSymbol) - the transposed chord  
-<a name="ChordSymbol+transpose"></a>
+**Kind**: instance method of [<code>Chord</code>](#Chord)  
+**Returns**: [<code>Chord</code>](#Chord) - the new, transposed chord  
+<a name="Chord+transpose"></a>
 
-### chordSymbol.transpose(delta) ⇒ [<code>ChordSymbol</code>](#ChordSymbol)
+### chord.transpose(delta) ⇒ [<code>Chord</code>](#Chord)
 Transposes the chord by the specified number of semitones
 
-**Kind**: instance method of [<code>ChordSymbol</code>](#ChordSymbol)  
-**Returns**: [<code>ChordSymbol</code>](#ChordSymbol) - the transposed chord  
+**Kind**: instance method of [<code>Chord</code>](#Chord)  
+**Returns**: [<code>Chord</code>](#Chord) - the new, transposed chord  
 
 | Param | Description |
 | --- | --- |
 | delta | de number of semitones |
 
-<a name="ChordSymbol+toString"></a>
-
-### chordSymbol.toString() ⇒ <code>string</code> \| <code>\*</code>
-Convert the chord to a string, eg. `'Esus4/G#'`
-
-**Kind**: instance method of [<code>ChordSymbol</code>](#ChordSymbol)  
-<a name="NumericChord"></a>
-
-## NumericChord
-Represents a numeric chord, such as b3sus4
-
-**Kind**: global class  
-
-* [NumericChord](#NumericChord)
-    * [.normalize()](#NumericChord+normalize) ⇒ [<code>NumericChord</code>](#NumericChord)
-    * [.switchModifier()](#NumericChord+switchModifier) ⇒ [<code>NumericChord</code>](#NumericChord)
-    * [.useModifier()](#NumericChord+useModifier) ⇒ [<code>NumericChord</code>](#NumericChord)
-    * [.transposeUp()](#NumericChord+transposeUp) ⇒ [<code>NumericChord</code>](#NumericChord)
-    * [.transposeDown()](#NumericChord+transposeDown) ⇒ [<code>NumericChord</code>](#NumericChord)
-    * [.transpose(delta)](#NumericChord+transpose) ⇒ [<code>NumericChord</code>](#NumericChord)
+<a name="Chord.parse"></a>
 
-<a name="NumericChord+normalize"></a>
-
-### numericChord.normalize() ⇒ [<code>NumericChord</code>](#NumericChord)
-Normalizes the chord - this is a noop for numeric chords.
+### Chord.parse(chordString) ⇒ <code>null</code> \| [<code>Chord</code>](#Chord)
+Tries to parse a chord string into a chord
 
-**Kind**: instance method of [<code>NumericChord</code>](#NumericChord)  
-**Returns**: [<code>NumericChord</code>](#NumericChord) - a copy of the chord object  
-<a name="NumericChord+switchModifier"></a>
+**Kind**: static method of [<code>Chord</code>](#Chord)  
 
-### numericChord.switchModifier() ⇒ [<code>NumericChord</code>](#NumericChord)
-Switches between '#' and 'b' as modifiers - this is a noop for numeric chords.
+| Param | Description |
+| --- | --- |
+| chordString | the chord string, eg `Esus4/G#` or `1sus4/#3` |
 
-**Kind**: instance method of [<code>NumericChord</code>](#NumericChord)  
-**Returns**: [<code>NumericChord</code>](#NumericChord) - a copy of the chord object  
-<a name="NumericChord+useModifier"></a>
+<a name="ChordSheetSerializer"></a>
 
-### numericChord.useModifier() ⇒ [<code>NumericChord</code>](#NumericChord)
-Switches to the specified modifier - this is a noop for numeric chords.
+## ChordSheetSerializer
+Serializes a song into een plain object, and deserializes the serialized object back into a [Song](#Song)
 
-**Kind**: instance method of [<code>NumericChord</code>](#NumericChord)  
-**Returns**: [<code>NumericChord</code>](#NumericChord) - a copy of the chord object  
-<a name="NumericChord+transposeUp"></a>
+**Kind**: global class  
 
-### numericChord.transposeUp() ⇒ [<code>NumericChord</code>](#NumericChord)
-Transposes the chord up by 1 semitone - this is a noop for numeric chords.
+* [ChordSheetSerializer](#ChordSheetSerializer)
+    * [.serialize()](#ChordSheetSerializer+serialize) ⇒
+    * [.deserialize(serializedSong)](#ChordSheetSerializer+deserialize) ⇒ [<code>Song</code>](#Song)
 
-**Kind**: instance method of [<code>NumericChord</code>](#NumericChord)  
-**Returns**: [<code>NumericChord</code>](#NumericChord) - a copy of the chord object  
-<a name="NumericChord+transposeDown"></a>
+<a name="ChordSheetSerializer+serialize"></a>
 
-### numericChord.transposeDown() ⇒ [<code>NumericChord</code>](#NumericChord)
-Transposes the chord down by 1 semitone - this is a noop for numeric chords.
+### chordSheetSerializer.serialize() ⇒
+Serializes the chord sheet to a plain object, which can be converted to any format like JSON, XML etc
+Can be deserialized using [deserialize](deserialize)
 
-**Kind**: instance method of [<code>NumericChord</code>](#NumericChord)  
-**Returns**: [<code>NumericChord</code>](#NumericChord) - a copy of the chord object  
-<a name="NumericChord+transpose"></a>
+**Kind**: instance method of [<code>ChordSheetSerializer</code>](#ChordSheetSerializer)  
+**Returns**: object A plain JS object containing all chord sheet data  
+<a name="ChordSheetSerializer+deserialize"></a>
 
-### numericChord.transpose(delta) ⇒ [<code>NumericChord</code>](#NumericChord)
-Transposes the chord by the specified number of semitones - this is a noop for numeric chords.
+### chordSheetSerializer.deserialize(serializedSong) ⇒ [<code>Song</code>](#Song)
+Deserializes a song that has been serialized using [serialize](serialize)
 
-**Kind**: instance method of [<code>NumericChord</code>](#NumericChord)  
-**Returns**: [<code>NumericChord</code>](#NumericChord) - a copy of the chord object  
+**Kind**: instance method of [<code>ChordSheetSerializer</code>](#ChordSheetSerializer)  
+**Returns**: [<code>Song</code>](#Song) - The deserialized song  
 
-| Param | Description |
-| --- | --- |
-| delta | de number of semitones |
+| Param | Type | Description |
+| --- | --- | --- |
+| serializedSong | <code>object</code> | The serialized song |
 
 <a name="ALBUM"></a>
 
@@ -1393,6 +1412,12 @@ Duration meta directive. See https://www.chordpro.org/chordpro/directives-durati
 ## END\_OF\_CHORUS : <code>string</code>
 End of chorus directive. See https://www.chordpro.org/chordpro/directives-env_chorus/
 
+**Kind**: global constant  
+<a name="END_OF_TAB"></a>
+
+## END\_OF\_TAB : <code>string</code>
+End of tab directive. See https://www.chordpro.org/chordpro/directives-env_tab/
+
 **Kind**: global constant  
 <a name="END_OF_VERSE"></a>
 
@@ -1423,6 +1448,12 @@ Lyricist meta directive. See https://www.chordpro.org/chordpro/directives-lyrici
 ## START\_OF\_CHORUS : <code>string</code>
 Start of chorus directive. See https://www.chordpro.org/chordpro/directives-env_chorus/
 
+**Kind**: global constant  
+<a name="START_OF_TAB"></a>
+
+## START\_OF\_TAB : <code>string</code>
+Start of tab directive. See https://www.chordpro.org/chordpro/directives-env_tab/
+
 **Kind**: global constant  
 <a name="START_OF_VERSE"></a>
 
@@ -1490,6 +1521,12 @@ Used to mark a paragraph as not containing a line marked with a type
 ## INDETERMINATE : <code>string</code>
 Used to mark a paragraph as containing lines with both verse and chorus type
 
+**Kind**: global constant  
+<a name="TAB"></a>
+
+## TAB : <code>string</code>
+Used to mark a paragraph as tab
+
 **Kind**: global constant  
 <a name="scopedCss"></a>
 
@@ -1505,7 +1542,9 @@ Generates basic CSS, scoped within the provided selector, to use with output gen
 
 <a name="parseChord"></a>
 
-## parseChord(chordString) ⇒ <code>null</code> \| [<code>ChordSymbol</code>](#ChordSymbol) \| [<code>NumericChord</code>](#NumericChord)
+## ~~parseChord(chordString) ⇒ <code>null</code> \| [<code>Chord</code>](#Chord)~~
+***Deprecated***
+
 Tries to parse a chord string into a chord
 
 **Kind**: global function  
@@ -1514,16 +1553,3 @@ Tries to parse a chord string into a chord
 | --- | --- |
 | chordString | the chord string, eg Esus4/G# or 1sus4/#3 |
 
-<a name="toChordSymbol"></a>
-
-## toChordSymbol(numericChord, key) ⇒ [<code>ChordSymbol</code>](#ChordSymbol)
-Converts a numeric chord into a chord symbol, using the provided key
-
-**Kind**: global function  
-**Returns**: [<code>ChordSymbol</code>](#ChordSymbol) - the resulting chord symbol  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| numericChord | [<code>NumericChord</code>](#NumericChord) |  |
-| key | <code>string</code> | the to use, sp anything between Ab and G# |
-

package/d7b54993c4ea66c07a35bd36690482ab620f836e.patch

@@ -0,0 +1,105 @@
+commit d7b54993c4ea66c07a35bd36690482ab620f836e
+Author: Martijn Versluis <martijnversluis@users.noreply.github.com>
+Date:   Sun Jan 30 16:35:24 2022 +0100
+
+    Do not rely on contructor name
+    
+    Due to build tools scrambling constructor names, we can not rely on those
+    for type checking. Thus we have to use `instanceof`. This change removes
+    usages of `constructor.name` and solves the cyclic dependency by moving around
+    some functions.
+    
+    Resolves #421
+
+diff --git a/src/formatter/html_div_formatter.js b/src/formatter/html_div_formatter.js
+index f92f532..b1de230 100644
+--- a/src/formatter/html_div_formatter.js
++++ b/src/formatter/html_div_formatter.js
+@@ -1,6 +1,6 @@
+ import Handlebars from 'handlebars';
+ 
+-import '../handlebars_helpers';
++import '../template_helpers';
+ import HtmlFormatter from './html_formatter';
+ import './templates/html_div_formatter';
+ import { scopeCss } from '../utilities';
+diff --git a/src/formatter/html_table_formatter.js b/src/formatter/html_table_formatter.js
+index 4883fef..7d7e8ea 100644
+--- a/src/formatter/html_table_formatter.js
++++ b/src/formatter/html_table_formatter.js
+@@ -1,6 +1,6 @@
+ import Handlebars from 'handlebars';
+ 
+-import '../handlebars_helpers';
++import '../template_helpers';
+ import HtmlFormatter from './html_formatter';
+ import './templates/html_table_formatter';
+ import { scopeCss } from '../utilities';
+diff --git a/src/formatter/text_formatter.js b/src/formatter/text_formatter.js
+index 61385f1..81fe226 100644
+--- a/src/formatter/text_formatter.js
++++ b/src/formatter/text_formatter.js
+@@ -1,10 +1,10 @@
+ import ChordLyricsPair from '../chord_sheet/chord_lyrics_pair';
+ import Tag from '../chord_sheet/tag';
+ import { renderChord } from '../helpers';
++import { hasTextContents } from '../template_helpers';
+ 
+ import {
+   hasChordContents,
+-  hasTextContents,
+   padLeft,
+ } from '../utilities';
+ 
+diff --git a/src/handlebars_helpers.js b/src/template_helpers.js
+similarity index 87%
+rename from src/handlebars_helpers.js
+rename to src/template_helpers.js
+index 0e5ff98..b330f87 100644
+--- a/src/handlebars_helpers.js
++++ b/src/template_helpers.js
+@@ -7,12 +7,20 @@ import { renderChord } from './helpers';
+ 
+ import {
+   hasChordContents,
+-  hasTextContents,
+   isEvaluatable,
+ } from './utilities';
+ 
+ const lineHasContents = (line) => line.items.some((item) => item.isRenderable());
+ 
++/* eslint import/prefer-default-export: 0 */
++export const hasTextContents = (line) => (
++  line.items.some((item) => (
++    (item instanceof ChordLyricsPair && item.lyrics)
++    || (item instanceof Tag && item.isRenderable())
++    || isEvaluatable(item)
++  ))
++);
++
+ HandleBars.registerHelper('isChordLyricsPair', (item) => item instanceof ChordLyricsPair);
+ 
+ HandleBars.registerHelper('isTag', (item) => item instanceof Tag);
+diff --git a/src/utilities.js b/src/utilities.js
+index 03c69cc..503c811 100644
+--- a/src/utilities.js
++++ b/src/utilities.js
+@@ -8,18 +8,6 @@ export const hasChordContents = (line) => line.items.some((item) => !!item.chord
+ 
+ export const isEvaluatable = (item) => typeof item.evaluate === 'function';
+ 
+-function isInstanceOf(object, constructorName) {
+-  return object?.constructor?.name === constructorName;
+-}
+-
+-export const hasTextContents = (line) => (
+-  line.items.some((item) => (
+-    (isInstanceOf(item, 'ChordLyricsPair') && item.lyrics)
+-      || (isInstanceOf(item, 'Tag') && item.isRenderable())
+-      || isEvaluatable(item)
+-  ))
+-);
+-
+ export const padLeft = (str, length) => {
+   let paddedString = str;
+   for (let l = str.length; l < length; l += 1, paddedString += ' ');