Skip to main content

Navigate

The Navigate class is an action class in the Screenplay pattern designed for use with the @testla/screenplay library. This class enables actors to navigate to a specified URL using the BrowseTheWeb ability provided by Testla.

Extends​

This class extends the abstract Action class from Core.

Methods​

performAs​

public async performAs(actor: Actor): Promise<any>;
  • Description: Navigates to the specified URL.
  • Parameters:
    • actor - The actor performing this action.
  • Returns: Promise<any> - Returns the main resource response.

to​

public static to(url: string): Navigate;
  • Description: Creates a new instance of the Navigate class specifically for navigating to a certain URL.
  • Parameters:
    • url - The URL which should be accessed.
  • Returns: Navigate - Returns a new Navigate instance.

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'),
);