Class Press

Press the specified key on the keyboard.

Hierarchy

Action
- Press

Index

Properties

abilityAlias? callStack?

Methods - Factory

Methods - Other

addToCallStack setCallStackInitializeCalledWith withAbilityAlias

Methods - called internally

Properties

`Optional` abilityAlias

abilityAlias?: string

`Optional` callStack

callStack?: CallStackInfo[]

Methods - Factory

`Static` characters

characters(locator, input, options?): Press
Press the specified keys sequentially for each string character To press a special key, like Control or ArrowDown, use key.
Parameters
- locator: Locator
  the locator.
- input: string
  the keys of characters to press.
- Optional options: PressActionOptions
  (optional) options for the press action.
Returns Press
new Press instance
Example
keys of characters
```
Press.characters('abcdefghijklmnopqrstuvwxyz');
```
- Defined in src/web/actions/Press.ts:87

`Static` key

key(keys, options?): Press
Press a key on the keyboard. (or multiple keys with +, e.g. Shift+A)
Parameters
- keys: string
  the key(s) to press.
- Optional options: PressActionOptions
  (optional) options for the press action.
Returns Press
new Press instance
Example
single key
```
Press.key('A');
```
multiple keys
```
Press.key('Control+A')
```
- Defined in src/web/actions/Press.ts:63

Methods - Other

addToCallStack

addToCallStack(entry): void
Parameters
- entry: CallStackInfo
Returns void
Inherited from Action.addToCallStack
- Defined in node_modules/@testla/screenplay/lib/templates/UsingLogging.d.ts:6

setCallStackInitializeCalledWith

setCallStackInitializeCalledWith(calledWith): void
Parameters
- calledWith: CallStackCalledWith
Returns void
Inherited from Action.setCallStackInitializeCalledWith
- Defined in node_modules/@testla/screenplay/lib/templates/UsingLogging.d.ts:5

withAbilityAlias

withAbilityAlias(alias): this
Set the alias which is used for an underlying ability
Parameters
- alias: undefined | string
  with which an ability was initialized
Returns this
current action
Inherited from Action.withAbilityAlias
- Defined in node_modules/@testla/screenplay/lib/templates/UsingAlias.d.ts:10

Methods - called internally

performAs

performAs(actor): Promise<void>
Press the specified key.
Parameters
- actor: Actor
  Actor performing this action
Returns Promise<void>
Returns when the key can specify the intended value or a single character to generate the text for.
Overrides Action.performAs
- Defined in src/web/actions/Press.ts:32

Generated using TypeDoc