Skip to main content

Function: sanitiseShortcutBindings()

sanitiseShortcutBindings(input, defaults): ShortcutBindings

Defined in: src/lib/utils/shortcuts/index.ts:301

Keep valid key combinations from an untrusted value (e.g. stored or imported), using defaults for actions that are missing or invalid. null removes an action's key combination. A key combination a fixed action uses, or that an earlier action (in SHORTCUT_DEFINITIONS order) already has, is removed. Unknown actions are left out.

Parameters​

input​

unknown

defaults​

ShortcutBindings

Returns​

ShortcutBindings

Example​

sanitiseShortcutBindings({ "tool-brush": { key: "p" }, cut: null }, defaultShortcutBindings());