API / @aionbuilders/nabu/extend

parseChord

Function Stability: stable

Parse a chord string. Returns null for anything invalid: empty, unknown key name, unknown/duplicated modifier, or Shift on a digit/symbol (see the module doc).

Related guide: Commands and keymap →

Signature

TypeScript 
import { parseChord } from '@aionbuilders/nabu/extend';
TypeScript 
function parseChord(text: string, options?: object): Chord | null

Parameters

Parameters of parseChord
ParameterTypeDefaultDescription
textstringn/an/a
optionsoptionalobject{}n/a
options.platformoptionalPlatformn/an/a

Returns

Chord | null

Source: src/lib/utils/keys.js:70