Class ChordsOverWordsParser

Parses a chords over words sheet into a song

It support "regular" chord sheets:

       Am         C/G        F          C
Let it be, let it be, let it be, let it be
C                G              F  C/E Dm C
Whisper words of wisdom, let it be

Additionally, some chordpro features have been "ported back". For example, you can use chordpro directives:

{title: Let it be}
{key: C}
Chorus 1:
       Am
Let it be

For convenience, you can leave out the brackets:

title: Let it be
Chorus 1:
       Am
Let it be

You can even use a markdown style frontmatter separator to separate the header from the song:

title: Let it be
key: C
---
Chorus 1:
       Am         C/G        F          C
Let it be, let it be, let it be, let it be
C                G              F  C/E Dm C
Whisper words of wisdom, let it be

ChordsOverWordsParser is the better version of ChordSheetParser, which is deprecated.

Accessors

warnings

Methods

parse

Accessors

warnings

Methods

parse

  • parse(chordSheet: string, options?: ChordsOverWordsParserOptions): Song

  • Parses a chords over words sheet into a song

    Parameters

    • chordSheet: string

      the chords over words sheet

    • Optionaloptions: ChordsOverWordsParserOptions

      Parser options.

      • softLineBreaks=false

        If true, a backslash followed by a space is treated as a soft line break

      • chopFirstWord=false

        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

Settings

Member Visibility

On This Page

Accessors
Methods