Class Key

constructor

• new Key(
      ascii?: string,
      name?: KeyName,
      shiftPressed?: boolean,
      ctrlPressed?: boolean,
      isNumpadKey?: boolean,
      altPressed?: boolean,
      altGraphPressed?: boolean,
      code?: string,
  ): Key

  Creates an input-method key value.

  Parameters

  • ascii: string = ''
  • name: KeyName = KeyName.UNKNOWN
  • shiftPressed: boolean = false

    Whether Shift is pressed.

  • ctrlPressed: boolean = false

    Whether Control is pressed.

  • isNumpadKey: boolean = false

    Whether the key originated from the numpad.

  • altPressed: boolean = false
  • altGraphPressed: boolean = false
  • code: string = ''

  Returns Key

ReadonlyaltGraphPressed

ReadonlyaltPressed

Readonlyascii

Readonlycode

ReadonlyctrlPressed

ReadonlyisNumpadKey

Readonlyname

ReadonlyshiftPressed

isCursorKey

• get isCursorKey(): boolean

  If the key is for moving the input cursor.

  Returns boolean

isDeleteKey

• get isDeleteKey(): boolean

  If the key is for deleting the previous character.

  Returns boolean

toString

• toString(): string

  Returns a string representation of the key.

  Returns string

  A string representation of the key.

StaticasciiKey

• asciiKey(c: string, shiftPressed?: boolean, ctrlPressed?: boolean): Key

  Creates a key with an ASCII character.

  Parameters

  • c: string

    The ASCII character.

  • shiftPressed: boolean = false

    If the shift key is pressed.

  • ctrlPressed: boolean = false

    If the control key is pressed.

  Returns Key

  The key.

StaticnamedKey

• namedKey(name: KeyName, shiftPressed?: boolean, ctrlPressed?: boolean): Key

  Creates a key with a name.

  Parameters

  • name: KeyName

    The name of the key.

  • shiftPressed: boolean = false

    If the shift key is pressed.

  • ctrlPressed: boolean = false

    If the control key is pressed.

  Returns Key

  The key.