Skip to main content

Remove

The Remove class is an action class in the Screenplay pattern designed for use with the @testla/screenplay library. This class allows actors to remove either Session Storage Items or Local Storage Items from the browser using the BrowseTheWeb ability provided by Testla.

Extends​

This class extends the abstract Action class from Core.

Methods​

performAs​

public performAs(actor: Actor): Promise<any>;
  • Description: Removes either Session Storage Items or Local Storage Items from the browser.
  • Parameters:
    • actor - The actor performing this action.
  • Returns: Promise<any> - Returns the value of the pageFunction invocation.

sessionStorageItem​

public static sessionStorageItem(key: string): Remove;
  • Description: Creates a new instance of the Remove class specifically for removing a session storage item with the given key.
  • Parameters:
    • key - The key that specifies the item to be removed.
  • Returns: Remove - Returns a new Remove instance for session storage.

localStorageItem​

public static localStorageItem(key: string): Remove;
  • Description: Creates a new instance of the Remove class specifically for removing a local storage item with the given key.
  • Parameters:
    • key - The key that specifies the item to be removed.
  • Returns: Remove - Returns a new Remove instance for local storage.

Methods inherited from Core Action​

orSkipOnFail​

Introduced in core: 0.5.0

public get orSkipOnFail(): Action;
  • Description: Allows to skip an action on fail.
  • Returns: Action - Returns the current action.

Usage:

// Would skip the step on error without breaking the execution
await actor.attemptsTo(
    Do.something().orSkipOnFail,
);

withAbilityAlias​

Introduced in core: 0.3.0

public withAbilityAlias(alias: string): Action;
  • Description: Defines the ability alias to be used during execution.
  • Parameters:
    • alias - The alias.
  • Returns: Action - Returns the current action.

Usage:

await actor.attemptsTo(
    Do.something().withAbilityAlias('myAlias'),
);