Docs
CodeRabbit
Cloudflare
Railway
OpenRouter
AG Grid
WorkOS
Netlify
Clerk
SerpAPI
Sentry
Electric
Prisma
Unkey
CodeRabbit
Cloudflare
Railway
OpenRouter
AG Grid
WorkOS
Netlify
Clerk
SerpAPI
Sentry
Electric
Prisma
Unkey
API Reference
Hotkeys API Reference
Hotkey Sequence API Reference
Key hold & held keys API Reference
Hotkey Recorder API Reference
Hotkey Sequence Recorder API Reference
Normalization & format API Reference
Normalization & format API Reference

formatHotkey

Function: formatHotkey()

ts
function formatHotkey(parsed): string;
function formatHotkey(parsed): string;

Defined in: format.ts:53

Converts a ParsedHotkey back to a hotkey string.

Parameters

parsed

The parsed hotkey object

Returns

A hotkey string in canonical form

Example

ts
formatHotkey({ key: 'S', ctrl: true, shift: true, alt: false, meta: false, modifiers: ['Control', 'Shift'] })
// Returns: 'Control+Shift+S'
formatHotkey({ key: 'S', ctrl: true, shift: true, alt: false, meta: false, modifiers: ['Control', 'Shift'] })
// Returns: 'Control+Shift+S'