chordsheetjs
    Preparing search index...

    Class ChordProParser

    Parses a ChordPro chord sheet

    Index

    Accessors

    Methods

    Accessors

    Methods

    • 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

        • notation

          When 'german', every chord in the song is parsed using German notation (B = B-flat, H = B natural) and rendered accordingly. Defaults to English semantics where B is B natural and H is accepted as an alias for it.

      Returns Song

      The parsed song