API / @aionbuilders/nabu/extend

canonicalChord

Function Stability: stable

Parse then canonicalize a chord string.

Related guide: Commands and keymap →

Signature

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

Parameters

Parameters of canonicalChord
ParameterTypeDescription
textstringn/a
optionsoptionalobjectn/a
options.platformoptionalPlatformn/a

Returns

string | null

null when invalid

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