Skip to content

Latest commit

 

History

History
201 lines (148 loc) · 5.52 KB

element.md

File metadata and controls

201 lines (148 loc) · 5.52 KB

Back to overview

Element

The Element class is a question class in the Screenplay pattern designed for use with the @testla/screenplay library. This class enables actors to inquire about the state of a web element, such as visibility, enabled state, text, or value, using the BrowseTheWeb ability provided by Testla.

Table of Contents

Class Overview

Methods

answeredBy

public async answeredBy(actor: Actor): Promise<boolean>;
  • Description: Verifies if an element is in the specified state (visible, enabled, has text, or has value).
  • Parameters:
    • actor - The actor answering this question.
  • Returns: Promise<boolean> - Resolves to true for a positive check, false for a negative check.

toBe

public static get toBe(): Element;
  • Description: Creates a new instance of the Element class for a positive check.
  • Returns: Element - Returns a new Element instance.

notToBe

public static get notToBe(): Element;
  • Description: Creates a new instance of the Element class for a negative check.
  • Returns: Element - Returns a new Element instance.

toHave

public static get toHave(): Element;
  • Description: Alias for toBe. Creates a new instance of the Element class for a positive check.
  • Returns: Element - Returns a new Element instance.

notToHave

public static get notToHave(): Element;
  • Description: Alias for notToBe. Creates a new instance of the Element class for a negative check.
  • Returns: Element - Returns a new Element instance.

visible

public visible(selector: Selector, options?: SelectorOptions): Element;
  • Description: Verifies if an element is visible.
  • Parameters:
    • selector - The selector.
    • options - (optional) Advanced selector lookup options.
  • Returns: Element - Returns this Element instance.

enabled

public enabled(selector: Selector, options?: SelectorOptions): Element;
  • Description: Verifies if an element is enabled.
  • Parameters:
    • selector - The selector.
    • options - (optional) Advanced selector lookup options.
  • Returns: Element - Returns this Element instance.

checked

public enabled(selector: Selector, options?: SelectorOptions): Element;
  • Description: Verifies if an element is checked.
  • Parameters:
    • selector - The selector.
    • options - (optional) Advanced selector lookup options.
  • Returns: Element - Returns this Element instance.

text

public text(selector: Selector, text: string | RegExp | (string | RegExp)[], options?: SelectorOptions): Element;
  • Description: Verifies if an element has the given text.
  • Parameters:
    • selector - The selector.
    • text - The text to check.
    • options - (optional) Advanced selector lookup options.
  • Returns: Element - Returns this Element instance.

value

public value(selector: Selector, value: string | RegExp, options?: SelectorOptions): Element;
  • Description: Verifies if an element has the given value.
  • Parameters:
    • selector - The selector.
    • value - The value to check.
    • options - (optional) Advanced selector lookup options.
  • Returns: Element - Returns this Element instance.

count

public count(selector: Selector, desiredCount: number, options?: SelectorOptions): Element;
  • Description: Verifies if an element has a desired count.
  • Parameters:
    • selector - The selector.
    • desiredCount - The desired count.
    • options - (optional) Advanced selector lookup options.
  • Returns: Element - Returns this Element instance.

minCount

public minCount(selector: Selector, minimumCount: number, options?: SelectorOptions): Element;
  • Description: Verifies if an element has a minimum count.
  • Parameters:
    • selector - The selector.
    • minimumCount - The minimum count.
    • options - (optional) Advanced selector lookup options.
  • Returns: Element - Returns this Element instance.

inFrame

public inFrame(frameSelector: FrameSelector): Element;
  • Description: Finds the specified frame selector using the BrowseTheWeb ability.
  • Parameters:
    • frameSelector - The FrameSelector.
  • Returns: Element - Returns the current action.

withAbilityAlias

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

failAsFalse

Introduced in: 1.6.0

public get failAsFalse(): Element;
  • Description: Returns false instead of failing when exception occurrs.
  • Returns: Element - Returns the current question.

Back to overview