Type Alias ParseChordParams

The parameters accepted by the parseChord function.

type ParseChordParams = {
    chordName?: string;
    includeOpenStrings?: boolean;
    input: string;
    system: FretboardSystem;
}

Index

Properties

chordName? includeOpenStrings? input system

Properties

`Optional`chordName

chordName?: string

The chord name (e.g. C major, A7b9).

`Optional`includeOpenStrings

includeOpenStrings?: boolean

Shows the open string notes.

input

input: string

The chord input (e.g. x32010).

system

system: FretboardSystem

The current fretboard system (needed to determine the note names).