chordsheetjs
    Preparing search index...

    Class ChordSheetParser

    Parses a normal chord sheet

    ChordSheetParser is deprecated, please use ChordsOverWordsParser.

    ChordsOverWordsParser aims to support any kind of chord, whereas ChordSheetParser lacks support for many variations. Besides that, some chordpro feature have been ported back to ChordsOverWordsParser, which adds some interesting functionality.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Methods

    parse

    Constructors

    • Instantiate a chord sheet parser ChordSheetParser is deprecated, please use ChordsOverWordsParser.

      Parameters

      • Optionaloptions: { preserveWhitespace?: boolean } = {}

        options

        • OptionalpreserveWhitespace?: boolean

          whether to preserve trailing whitespace for chords

      • showDeprecationWarning: boolean = true

      Returns ChordSheetParser

    Methods

    • Parses a chord sheet into a song

      Parameters

      • chordSheet: string

        The ChordPro chord sheet

      • Optionaloptions: { song?: Song } = {}

        Optional parser options

        • Optionalsong?: Song

          The Song to store the song data in

      Returns Song

      The parsed song

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods