Class ChordProParser

Parses a ChordPro chord sheet

Index

Accessors

Methods

Accessors

warnings

get warnings(): ParserWarning[]
All warnings raised during parsing the chord sheet

Returns ParserWarning[]
Member
- Defined in parser/chord_pro_parser.ts:24

Methods

parse

parse(chordSheet: string, options?: ChordProParserOptions): Song
Parses a ChordPro chord sheet into a song
Parameters
- chordSheet: string
  the ChordPro chord sheet
- Optionaloptions: ChordProParserOptions
  Parser options.
  - softLineBreaks=false
    If true, a backslash followed by * a space is treated as a soft line break
  - chopFirstWord=true
    If true, only the first lyric word is paired with the chord, the rest of the lyric is put in a separate chord lyric pair
Returns Song
The parsed song

See
https://peggyjs.org/documentation.html#using-the-parser
- Defined in parser/chord_pro_parser.ts:39