Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ValuePageElementGroupWait<Store, Content, GroupType>

This class defines all wait functions of ValuePageElementGroup.

template

Store type of the PageNodeStore instance which can be used to retrieve/create PageNodes

template

Content an arbitrary object structure of PageNode instances as values and the names used to identify these PageNodes as keys

template

GroupType type of the ValuePageElementGroup for which ValuePageElementGroupWait defines all wait functions

Type parameters

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Protected _node

_node: GroupType

the PageNode for which PageNodeWait defines all wait functions

Accessors

not

  • get not(): object

  • returns the negated variants of ValuePageElementGroupWait's state check functions

    Returns object

    • containsValue: function

      • Waits for the actual values of all PageNodes managed by ValuePageElementGroup not to contain the expected values.

        Throws an error if the condition is not met within a specific timeout.

        Parameters

        • values: ExtractValueStateChecker<Content>

          the expected values supposed not to be contained in the actual values

        • Optional opts: ITimeoutInterval

          includes the timeout within which the condition is expected to be met and the interval used to check it

          If no timeout is specified, a ValuePageElement's default timeout is used. If no interval is specified, a ValuePageElement's default interval is used.

        Returns GroupType

        this (an instance of ValuePageElementGroup)

    • hasAnyValue: function

      • Waits for all PageNodes managed by ValuePageElementGroup not to have any value.

        Throws an error if the condition is not met within a specific timeout.

        Parameters

        • Default value opts: ITimeoutInterval & ValueGroupFilterMask<Content> = {}

          includes a filterMask which can be used to skip the invocation of the hasAnyValue function for some or all managed PageNodes, the timeout within which the condition is expected to be met and the interval used to check it

          If no timeout is specified, a ValuePageElement's default timeout is used. If no interval is specified, a ValuePageElement's default interval is used.

        Returns GroupType

        this (an instance of ValuePageElementGroup)

    • hasValue: function

      • Waits for the actual values of all PageNodes managed by ValuePageElementGroup not to equal the expected values.

        Throws an error if the condition is not met within a specific timeout.

        Parameters

        • values: ExtractValueStateChecker<Content>

          the expected values supposed not to equal the actual values

        • Optional opts: ITimeoutInterval

          includes the timeout within which the condition is expected to be met and the interval used to check it

          If no timeout is specified, a ValuePageElement's default timeout is used. If no interval is specified, a ValuePageElement's default interval is used.

        Returns GroupType

        this (an instance of ValuePageElementGroup)

Methods

containsDirectText

  • Waits for the actual direct texts of all PageNodes managed by PageElementGroup to contain the expected direct texts.

    Throws an error if the condition is not met within a specific timeout.

    A direct text is a text that resides on the level directly below the selected HTML element. It does not include any text of the HTML element's nested children HTML elements.

    Parameters

    • directTexts: ExtractTextStateChecker<Content>

      the expected direct texts supposed to be contained in the actual direct texts

    • Optional opts: ITimeoutInterval

      includes the timeout within which the condition is expected to be met and the interval used to check it

      If no timeout is specified, a PageElement's default timeout is used. If no interval is specified, a PageElement's default interval is used.

    Returns GroupType

    this (an instance of PageElementGroup)

containsText

  • Waits for the actual texts of all PageNodes managed by PageElementGroup to contain the expected texts.

    Throws an error if the condition is not met within a specific timeout.

    Parameters

    • texts: ExtractTextStateChecker<Content>

      the expected texts supposed to be contained in the actual texts

    • Optional opts: ITimeoutInterval

      includes the timeout within which the condition is expected to be met and the interval used to check it

      If no timeout is specified, a PageElement's default timeout is used. If no interval is specified, a PageElement's default interval is used.

    Returns GroupType

    this (an instance of PageElementGroup)

containsValue

  • Waits for the actual values of all PageNodes managed by ValuePageElementGroup to contain the expected values.

    Throws an error if the condition is not met within a specific timeout.

    Parameters

    • values: ExtractValueStateChecker<Content>

      the expected values supposed to be contained in the actual values

    • Optional opts: ITimeoutInterval

      includes the timeout within which the condition is expected to be met and the interval used to check it

      If no timeout is specified, a ValuePageElement's default timeout is used. If no interval is specified, a ValuePageElement's default interval is used.

    Returns GroupType

    this (an instance of ValuePageElementGroup)

exists

  • Waits for all PageNodes managed by PageElementGroup to exist.

    Throws an error if the condition is not met within a specific timeout.

    Parameters

    • Default value opts: ITimeout & IGroupFilterMaskExists<Content> = {}

      includes a filterMask which can be used to skip the invocation of the exists function for some or all managed PageNodes and the timeout within which the condition is expected to be met

      If no timeout is specified, a PageElement's default timeout is used.

    Returns GroupType

    this (an instance of PageElementGroup)

hasAnyDirectText

  • Waits for all PageNodes managed by PageElementGroup to have any direct text.

    Throws an error if the condition is not met within a specific timeout.

    A direct text is a text that resides on the level directly below the selected HTML element. It does not include any text of the HTML element's nested children HTML elements.

    Parameters

    • Default value opts: ITimeoutInterval & IGroupFilterMask<Content> = {}

      includes a filterMask which can be used to skip the invocation of the hasAnyDirectText function for some or all managed PageNodes, the timeout within which the condition is expected to be met and the interval used to check it

      If no timeout is specified, a PageElement's default timeout is used. If no interval is specified, a PageElement's default interval is used.

    Returns GroupType

    this (an instance of PageElementGroup)

hasAnyText

  • Waits for all PageNodes managed by PageElementGroup to have any text.

    Throws an error if the condition is not met within a specific timeout.

    Parameters

    • Default value opts: ITimeoutInterval & IGroupFilterMask<Content> = {}

      includes a filterMask which can be used to skip the invocation of the hasAnyText function for some or all managed PageNodes, the timeout within which the condition is expected to be met and the interval used to check it

      If no timeout is specified, a PageElement's default timeout is used. If no interval is specified, a PageElement's default interval is used.

    Returns GroupType

    this (an instance of PageElementGroup)

hasAnyValue

  • Waits for all PageNodes managed by ValuePageElementGroup to have any value.

    Throws an error if the condition is not met within a specific timeout.

    Parameters

    • Default value opts: ITimeoutInterval & ValueGroupFilterMask<Content> = {}

      includes a filterMask which can be used to skip the invocation of the hasAnyValue function for some or all managed PageNodes, the timeout within which the condition is expected to be met and the interval used to check it

      If no timeout is specified, a ValuePageElement's default timeout is used. If no interval is specified, a ValuePageElement's default interval is used.

    Returns GroupType

    this (an instance of ValuePageElementGroup)

hasDirectText

  • Waits for the actual direct texts of all PageNodes managed by PageElementGroup to equal the expected direct texts.

    Throws an error if the condition is not met within a specific timeout.

    A direct text is a text that resides on the level directly below the selected HTML element. It does not include any text of the HTML element's nested children HTML elements.

    Parameters

    • directTexts: ExtractTextStateChecker<Content>

      the expected direct texts supposed to equal the actual direct texts

    • Optional opts: ITimeoutInterval

      includes the timeout within which the condition is expected to be met and the interval used to check it

      If no timeout is specified, a PageElement's default timeout is used. If no interval is specified, a PageElement's default interval is used.

    Returns GroupType

    this (an instance of PageElementGroup)

hasText

  • Waits for the actual texts of all PageNodes managed by PageElementGroup to equal the expected texts.

    Throws an error if the condition is not met within a specific timeout.

    Parameters

    • texts: ExtractTextStateChecker<Content>

      the expected texts supposed to equal the actual texts

    • Optional opts: ITimeoutInterval

      includes the timeout within which the condition is expected to be met and the interval used to check it

      If no timeout is specified, a PageElement's default timeout is used. If no interval is specified, a PageElement's default interval is used.

    Returns GroupType

    this (an instance of PageElementGroup)

hasValue

  • Waits for the actual values of all PageNodes managed by ValuePageElementGroup to equal the expected values.

    Throws an error if the condition is not met within a specific timeout.

    Parameters

    • values: ExtractValueStateChecker<Content>

      the expected values supposed to equal the actual values

    • Optional opts: ITimeoutInterval

      includes the timeout within which the condition is expected to be met and the interval used to check it

      If no timeout is specified, a ValuePageElement's default timeout is used. If no interval is specified, a ValuePageElement's default interval is used.

    Returns GroupType

    this (an instance of ValuePageElementGroup)

isEnabled

  • Waits for all PageNodes managed by PageElementGroup to be enabled.

    Throws an error if the condition is not met within a specific timeout.

    Parameters

    • Default value opts: ITimeout & IGroupFilterMask<Content> = {}

      includes a filterMask which can be used to skip the invocation of the isEnabled function for some or all managed PageNodes and the timeout within which the condition is expected to be met

      If no timeout is specified, a PageElement's default timeout is used.

    Returns GroupType

    this (an instance of PageElementGroup)

isVisible

  • Waits for all PageNodes managed by PageElementGroup to be visible.

    Throws an error if the condition is not met within a specific timeout.

    Parameters

    • Default value opts: ITimeout & IGroupFilterMask<Content> = {}

      includes a filterMask which can be used to skip the invocation of the isVisible function for some or all managed PageNodes and the timeout within which the condition is expected to be met

      If no timeout is specified, a PageElement's default timeout is used.

    Returns GroupType

    this (an instance of PageElementGroup)

Generated using TypeDoc