tuil
ReferencePackages@mwillbanks/tuil-hotkeysAPI

normalizeTerminalKey

function exported by @mwillbanks/tuil-hotkeys.

View rawEdit

function

Public function exported by @mwillbanks/tuil-hotkeys.

export function normalizeTerminalKey(
  input: string,
  key: TerminalKey = {},
  platform: NodeJS.Platform = process.platform,
): string;

Members

This declaration has no public members.

Parameters

MemberTypeRequiredDescriptionRelated types
inputstringYesSupplies the input value as string.
keyTerminalKeyNoSupplies the key value as TerminalKey.TerminalKey
platformNodeJS.PlatformNoSupplies the platform value as NodeJS.Platform.

Returns

string — Returns a value that satisfies string.

Related types: —

Throws

No thrown errors are documented for this declaration.

Source

View the secondary source reference

Package

@mwillbanks/tuil-hotkeys

On this page