API / @aionbuilders/nabu/extend

eventChordId

Function Stability: stable

The canonical string of a keyboard event (see eventChord), or null.

Related guide: Commands and keymap →

Signature

TypeScript
import { eventChordId } from '@aionbuilders/nabu/extend';
TypeScript
function eventChordId(event: Pick<KeyboardEvent, 'key'> & Partial<KeyboardEvent>): string | null

Parameters

Parameters of eventChordId
ParameterTypeDescription
eventPick<KeyboardEvent, 'key'> & Partial<KeyboardEvent>n/a

Returns

string | null

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