Class ChordProFormatter

Formats a song into a ChordPro chord sheet

Hierarchy (View Summary)

Formatter
- ChordProFormatter

Index

Constructors

Methods

Constructors

constructor

new ChordProFormatter(
configuration?: ConfigurationProperties,
): ChordProFormatter
Instantiate
Parameters
- Optionalconfiguration: ConfigurationProperties = {}
  options
  - evaluate
    Whether or not to evaluate meta expressions. For more info about meta expressions, see: https://bit.ly/2SC9c2u
  - metadata
  - metadata.separator
    The separator to be used when rendering a metadata value that has multiple values. See: https://bit.ly/2SC9c2u
  - key
    The key to use for rendering. The chord sheet will be transposed from the song's original key (as indicated by the {key} directive) to the specified key. Note that transposing will only work if the original song key is set.
  - expandChorusDirective
    Whether or not to expand {chorus} directives by rendering the last defined chorus inline after the directive.
  - useUnicodeModifiers
    Whether or not to use unicode flat and sharp symbols.
  - normalizeChords
    Whether or not to automatically normalize chords
Returns ChordProFormatter
Inherited from Formatter.constructor
- Defined in formatter/formatter.ts:26

Methods

format

format(song: Song): string
Formats a song into a ChordPro chord sheet.
Parameters
- song: Song
  The song to be formatted
Returns string
The ChordPro string
- Defined in formatter/chord_pro_formatter.ts:24