Interface KeyboardProviderInterface

A KeyboardActionProvider should provide access to a systems keyboard

interface KeyboardProviderInterface {
    click(...keys): Promise<void>;
    pressKey(...keys): Promise<void>;
    releaseKey(...keys): Promise<void>;
    setKeyboardDelay(delay): void;
    type(input): Promise<void>;
}

Index

Methods

click pressKey releaseKey setKeyboardDelay type

Methods

click

click(...keys): Promise<void>
Click should allow to press a single key via OS level keyboard event
Parameters
- Rest ...keys: Key[]
  Array of Keys to click
Returns Promise<void>
- Defined in provider-interfaces/lib/keyboard-provider.interface.ts:26

pressKey

pressKey(...keys): Promise<void>
pressKey should allow to press and hold a key via OS level keyboard event
Parameters
- Rest ...keys: Key[]
  Array of Keys to press and hold
Returns Promise<void>
- Defined in provider-interfaces/lib/keyboard-provider.interface.ts:33

releaseKey

releaseKey(...keys): Promise<void>
releaseKey should release a pressed key via OS level keyboard event
Parameters
- Rest ...keys: Key[]
  Array of Keys to release
Returns Promise<void>
- Defined in provider-interfaces/lib/keyboard-provider.interface.ts:40

setKeyboardDelay

setKeyboardDelay(delay): void
setKeyboardDelay should allow to configure a delay between key presses
Parameters
- delay: number
  The delay between key presses in milliseconds
Returns void
- Defined in provider-interfaces/lib/keyboard-provider.interface.ts:12

type

type(input): Promise<void>
type should allow to type a given text via OS level keyboard events
Parameters
- input: string
  The text to type
Returns Promise<void>
- Defined in provider-interfaces/lib/keyboard-provider.interface.ts:19

Generated using TypeDoc