chordsheetjs 8.0.0 → 8.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +0 -25
- package/lib/bundle.js +22762 -2370
- package/lib/index.js +22762 -2370
- package/lib/index.js.map +1 -1
- package/lib/main.d.ts +63 -42
- package/lib/main.d.ts.map +1 -1
- package/lib/module.js +22833 -2441
- package/lib/module.js.map +1 -1
- package/package.json +8 -4
package/README.md
CHANGED
|
@@ -555,8 +555,6 @@ See https://www.chordpro.org/chordpro/directives-env_chorus/</p></dd>
|
|
|
555
555
|
<dd><p>Generates basic CSS, scoped within the provided selector, to use with output generated by [HtmlTableFormatter](#HtmlTableFormatter)</p></dd>
|
|
556
556
|
<dt><a href="#scopedCss">scopedCss(scope)</a> ⇒ <code>string</code></dt>
|
|
557
557
|
<dd><p>Generates basic CSS, scoped within the provided selector, to use with output generated by [HtmlTableFormatter](#HtmlTableFormatter)</p></dd>
|
|
558
|
-
<dt><del><a href="#parseChord">parseChord(chordString)</a> ⇒ <code><a href="#Chord">Chord</a></code> | <code>null</code></del></dt>
|
|
559
|
-
<dd><p>Tries to parse a chord string into a chord</p></dd>
|
|
560
558
|
<dt><a href="#getCapos">getCapos(key)</a> ⇒ <code>Object.<string, string></code></dt>
|
|
561
559
|
<dd><p>Returns applicable capos for the provided key</p></dd>
|
|
562
560
|
<dt><a href="#getKeys">getKeys(key)</a> ⇒ <code>Array.<string></code></dt>
|
|
@@ -798,7 +796,6 @@ If not, it returns [INDETERMINATE](#INDETERMINATE)</p>
|
|
|
798
796
|
* [.bodyParagraphs](#Song+bodyParagraphs) ⇒ [<code>Array.<Paragraph></code>](#Paragraph)
|
|
799
797
|
* [.paragraphs](#Song+paragraphs) : [<code>Array.<Paragraph></code>](#Paragraph)
|
|
800
798
|
* [.expandedBodyParagraphs](#Song+expandedBodyParagraphs) : [<code>Array.<Paragraph></code>](#Paragraph)
|
|
801
|
-
* ~~[.metaData](#Song+metaData) ⇒~~
|
|
802
799
|
* [.clone()](#Song+clone) ⇒ [<code>Song</code>](#Song)
|
|
803
800
|
* [.setKey(key)](#Song+setKey) ⇒ [<code>Song</code>](#Song)
|
|
804
801
|
* [.setCapo(capo)](#Song+setCapo) ⇒ [<code>Song</code>](#Song)
|
|
@@ -848,15 +845,6 @@ if you want to skip the "header lines": the lines that only contain me
|
|
|
848
845
|
<p>The body paragraphs of the song, with any <code>{chorus}</code> tag expanded into the targetted chorus</p>
|
|
849
846
|
|
|
850
847
|
**Kind**: instance property of [<code>Song</code>](#Song)
|
|
851
|
-
<a name="Song+metaData"></a>
|
|
852
|
-
|
|
853
|
-
### ~~song.metaData ⇒~~
|
|
854
|
-
***Deprecated***
|
|
855
|
-
|
|
856
|
-
<p>The song's metadata. Please use [metadata](metadata) instead.</p>
|
|
857
|
-
|
|
858
|
-
**Kind**: instance property of [<code>Song</code>](#Song)
|
|
859
|
-
**Returns**: <p>[Metadata](#Metadata) The metadata</p>
|
|
860
848
|
<a name="Song+clone"></a>
|
|
861
849
|
|
|
862
850
|
### song.clone() ⇒ [<code>Song</code>](#Song)
|
|
@@ -1998,19 +1986,6 @@ See https://www.chordpro.org/chordpro/directives-env_chorus/</p>
|
|
|
1998
1986
|
| --- | --- |
|
|
1999
1987
|
| scope | <p>the CSS scope to use, for example <code>.chordSheetViewer</code></p> |
|
|
2000
1988
|
|
|
2001
|
-
<a name="parseChord"></a>
|
|
2002
|
-
|
|
2003
|
-
## ~~parseChord(chordString) ⇒ [<code>Chord</code>](#Chord) \| <code>null</code>~~
|
|
2004
|
-
***Deprecated***
|
|
2005
|
-
|
|
2006
|
-
<p>Tries to parse a chord string into a chord</p>
|
|
2007
|
-
|
|
2008
|
-
**Kind**: global function
|
|
2009
|
-
|
|
2010
|
-
| Param | Description |
|
|
2011
|
-
| --- | --- |
|
|
2012
|
-
| chordString | <p>the chord string, eg Esus4/G# or 1sus4/#3</p> |
|
|
2013
|
-
|
|
2014
1989
|
<a name="getCapos"></a>
|
|
2015
1990
|
|
|
2016
1991
|
## getCapos(key) ⇒ <code>Object.<string, string></code>
|