Namespace Keybinding

Index

Functions

Functions

apiObjectify

apiObjectify(binding: Keybinding | RawKeybinding): Keybinding

- Defined in packages/core/src/common/keybinding.ts:81
Returns a new object only containing properties which are described on the Keybinding API.

Parameters
- binding: Keybinding | RawKeybinding
  
  the binding to create an API object for.
Returns Keybinding

equals

equals(a: Keybinding, b: Keybinding, ignoreKeybinding?: boolean, ignoreArgs?: boolean): boolean

- Defined in packages/core/src/common/keybinding.ts:64
Compares two keybindings for equality. Can optionally ignore the keybinding and/or args property in the comparison.

Parameters
- a: Keybinding
  
  The first Keybinding in the comparison
- b: Keybinding
  
  The second Keybinding in the comparison
- ignoreKeybinding: boolean = false
  
  Ignore the 'keybinding' property in the comparison
- ignoreArgs: boolean = false
  
  Ignore the 'args' property in the comparison
Returns boolean

is

is(arg: unknown): arg is Keybinding

- Defined in packages/core/src/common/keybinding.ts:107
Parameters
- arg: unknown
Returns arg is Keybinding

retrieveKeybinding

retrieveKeybinding(binding: Partial<Keybinding & RawKeybinding>): string

- Defined in packages/core/src/common/keybinding.ts:91
Parameters
- binding: Partial<Keybinding & RawKeybinding>
Returns string

stringify

stringify(binding: Keybinding): string

- Defined in packages/core/src/common/keybinding.ts:102
Returns with the string representation of the binding. Any additional properties which are not described on the Keybinding API will be ignored.

Parameters
- binding: Keybinding
  
  the binding to stringify.
Returns string