chordsheetjs 10.0.1 → 10.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 +13 -9
- package/lib/bundle.js +15310 -5275
- package/lib/bundle.min.js +114 -114
- package/lib/index.js +15337 -5296
- package/lib/index.js.map +1 -1
- package/lib/main.d.ts +60 -38
- package/lib/main.d.ts.map +1 -1
- package/lib/module.js +15337 -5296
- package/lib/module.js.map +1 -1
- package/package.json +31 -28
package/README.md
CHANGED
|
@@ -1295,7 +1295,7 @@ PDF conversion.</p>
|
|
|
1295
1295
|
|
|
1296
1296
|
* [ChordProParser](#ChordProParser)
|
|
1297
1297
|
* [.warnings](#ChordProParser+warnings) : [<code>Array.<ParserWarning></code>](#ParserWarning)
|
|
1298
|
-
* [.parse(chordSheet)](#ChordProParser+parse) ⇒ [<code>Song</code>](#Song)
|
|
1298
|
+
* [.parse(chordSheet, options)](#ChordProParser+parse) ⇒ [<code>Song</code>](#Song)
|
|
1299
1299
|
|
|
1300
1300
|
<a name="ChordProParser+warnings"></a>
|
|
1301
1301
|
|
|
@@ -1305,15 +1305,18 @@ PDF conversion.</p>
|
|
|
1305
1305
|
**Kind**: instance property of [<code>ChordProParser</code>](#ChordProParser)
|
|
1306
1306
|
<a name="ChordProParser+parse"></a>
|
|
1307
1307
|
|
|
1308
|
-
### chordProParser.parse(chordSheet) ⇒ [<code>Song</code>](#Song)
|
|
1308
|
+
### chordProParser.parse(chordSheet, options) ⇒ [<code>Song</code>](#Song)
|
|
1309
1309
|
<p>Parses a ChordPro chord sheet into a song</p>
|
|
1310
1310
|
|
|
1311
1311
|
**Kind**: instance method of [<code>ChordProParser</code>](#ChordProParser)
|
|
1312
1312
|
**Returns**: [<code>Song</code>](#Song) - <p>The parsed song</p>
|
|
1313
|
+
**See**: https://peggyjs.org/documentation.html#using-the-parser
|
|
1313
1314
|
|
|
1314
|
-
| Param | Type | Description |
|
|
1315
|
-
| --- | --- | --- |
|
|
1316
|
-
| chordSheet | <code>string</code> | <p>the ChordPro chord sheet</p> |
|
|
1315
|
+
| Param | Type | Default | Description |
|
|
1316
|
+
| --- | --- | --- | --- |
|
|
1317
|
+
| chordSheet | <code>string</code> | | <p>the ChordPro chord sheet</p> |
|
|
1318
|
+
| options | <code>ChordProParserOptions</code> | | <p>Parser options.</p> |
|
|
1319
|
+
| options.softLineBreaks | <code>ChordProParserOptions.softLineBreaks</code> | <code>false</code> | <p>If true, a backslash followed by * a space is treated as a soft line break</p> |
|
|
1317
1320
|
|
|
1318
1321
|
<a name="ChordSheetParser"></a>
|
|
1319
1322
|
|
|
@@ -1414,10 +1417,11 @@ Whisper words of wisdom, let it be
|
|
|
1414
1417
|
**Returns**: [<code>Song</code>](#Song) - <p>The parsed song</p>
|
|
1415
1418
|
**See**: https://peggyjs.org/documentation.html#using-the-parser
|
|
1416
1419
|
|
|
1417
|
-
| Param | Type | Description |
|
|
1418
|
-
| --- | --- | --- |
|
|
1419
|
-
| chordSheet | <code>string</code> | <p>the chords over words sheet</p> |
|
|
1420
|
-
| options | <code>
|
|
1420
|
+
| Param | Type | Default | Description |
|
|
1421
|
+
| --- | --- | --- | --- |
|
|
1422
|
+
| chordSheet | <code>string</code> | | <p>the chords over words sheet</p> |
|
|
1423
|
+
| options | <code>ChordsOverWordsParserOptions</code> | | <p>Parser options.</p> |
|
|
1424
|
+
| options.softLineBreaks | <code>ChordsOverWordsParserOptions.softLineBreaks</code> | <code>false</code> | <p>If true, a backslash followed by a space is treated as a soft line break</p> |
|
|
1421
1425
|
|
|
1422
1426
|
<a name="ParserWarning"></a>
|
|
1423
1427
|
|