Class KeyCode

constructor

• new KeyCode(schema: KeyCodeSchema): KeyCode

  Parameters

  • schema: KeyCodeSchema

  Returns KeyCode

Readonlyalt

Readonlycharacter

Readonlyctrl

Readonlykey

Readonlymeta

Readonlyshift

equals

• equals(other: KeyCode): boolean

  Return true if the given KeyCode is equal to this one.

  Parameters

  • other: KeyCode

  Returns boolean

isModifierOnly

• isModifierOnly(): boolean

  Return true if this KeyCode only contains modifiers.

  Returns boolean

toString

• toString(): string

  Return a keybinding string compatible with the Keybinding.keybinding property.

  Returns string

StaticcreateKeyCode

• createKeyCode(
      input: string | KeyboardEvent | Keystroke | KeyCodeSchema,
      eventDispatch?: "keyCode" | "code",
  ): KeyCode

  Create a KeyCode from one of several input types.

  Parameters

  • input: string | KeyboardEvent | Keystroke | KeyCodeSchema
  • eventDispatch: "keyCode" | "code" = 'code'

  Returns KeyCode

Staticparse

• parse(keybinding: string): KeyCode

  Parses a string and returns a KeyCode object.

  Parameters

  • keybinding: string

    String representation of a keybinding

  Returns KeyCode

StaticresetKeyBindings

• resetKeyBindings(): void

  Reset the key hashmap, this is for testing purposes.

  Returns void