Class UltimateGuitarParser

Parses an Ultimate Guitar chord sheet with metadata Inherits from ChordSheetParser

Hierarchy (View Summary)

ChordSheetParser
- UltimateGuitarParser

Index

Constructors

Methods

Constructors

constructor

new UltimateGuitarParser(
options?: { preserveWhitespace?: boolean },
): UltimateGuitarParser
Instantiate a chord sheet parser
Parameters
- Optionaloptions: { preserveWhitespace?: boolean } = {}
  options
  - OptionalpreserveWhitespace?: boolean
    whether to preserve trailing whitespace for chords
Returns UltimateGuitarParser
Overrides ChordSheetParser.constructor
- Defined in parser/ultimate_guitar_parser.ts:35

Methods

parse

parse(chordSheet: string, options?: { song?: Song }): Song
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
Inherited from ChordSheetParser.parse
- Defined in parser/chord_sheet_parser.ts:70