Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ICheckWait<TextType, BooleanType, FilterType, OptsType>

Used by IElementNode to describe wait state check functions supported by PageElement, PageElementList, PageElementMap and PageElementGroup.

Type parameters

  • TextType

  • BooleanType

  • FilterType

  • OptsType

Hierarchy

  • ICheckWait

Index

Properties

not

not: Omit<ICheckWait<TextType, BooleanType, FilterType, ITimeoutInterval>, "not">

returns the negated variants of ICheckWait's state check functions

Methods

containsDirectText

  • containsDirectText(directText: TextType, opts?: OptsType): IElementNode<TextType, BooleanType, FilterType>
  • Waits for a PageElement or for all PageElements managed by a PageElementList, PageElementMap or PageElementGroup to have an actual direct text which contains the expected direct text.

    Throws an error if the condition is not met within the 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

    • directText: TextType
    • Optional opts: OptsType

      includes the timeout within which the condition is expected to be met, the interval used to check it and a reverse flag that, if set to true, checks for the condition NOT to be met instead

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

    Returns IElementNode<TextType, BooleanType, FilterType>

containsText

  • containsText(text: TextType, opts?: OptsType): IElementNode<TextType, BooleanType, FilterType>
  • Waits for a PageElement or for all PageElements managed by a PageElementList, PageElementMap or PageElementGroup to have an actual text which contains the expected text.

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

    Parameters

    • text: TextType

      the expected text which is supposed to be contained in the actual text

    • Optional opts: OptsType

      includes the timeout within which the condition is expected to be met, the interval used to check it and a reverse flag that, if set to true, checks for the condition NOT to be met instead

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

    Returns IElementNode<TextType, BooleanType, FilterType>

exists

  • exists(opts?: OptsType & object): IElementNode<TextType, BooleanType, FilterType>
  • Waits for a PageElement or for all PageElements managed by a PageElementList, PageElementMap or PageElementGroup to exist within a specific timeout.

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

    Parameters

    • Optional opts: OptsType & object

      includes filterMask which can be used to skip the invocation of the state check function for some or all managed PageElements, the timeout within which the condition is expected to be met and a reverse flag that, if set to true, checks for the condition NOT to be met instead

      If no timeout is specified, PageNode's default timeout is used.

    Returns IElementNode<TextType, BooleanType, FilterType>

hasAnyDirectText

  • hasAnyDirectText(opts?: OptsType & object): IElementNode<TextType, BooleanType, FilterType>
  • Waits for a PageElement or for all PageElements managed by a PageElementList, PageElementMap or PageElementGroup to have any direct text.

    Throws an error if the condition is not met within the 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

    • Optional opts: OptsType & object

      includes the timeout within which the condition is expected to be met, the interval used to check it and a reverse flag that, if set to true, checks for the condition NOT to be met instead

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

    Returns IElementNode<TextType, BooleanType, FilterType>

hasAnyText

  • hasAnyText(opts?: OptsType & object): IElementNode<TextType, BooleanType, FilterType>
  • Waits for a PageElement or for all PageElements managed by a PageElementList, PageElementMap or PageElementGroup to have any text.

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

    Parameters

    • Optional opts: OptsType & object

      includes the timeout within which the condition is expected to be met, the interval used to check it and a reverse flag that, if set to true, checks for the condition NOT to be met instead

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

    Returns IElementNode<TextType, BooleanType, FilterType>

hasDirectText

  • hasDirectText(directText: TextType, opts?: OptsType): IElementNode<TextType, BooleanType, FilterType>
  • Waits for a PageElement or for all PageElements managed by a PageElementList, PageElementMap or PageElementGroup to have an actual direct text which equals the expected direct text.

    Throws an error if the condition is not met within the 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

    • directText: TextType
    • Optional opts: OptsType

      includes the timeout within which the condition is expected to be met, the interval used to check it and a reverse flag that, if set to true, checks for the condition NOT to be met instead

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

    Returns IElementNode<TextType, BooleanType, FilterType>

hasText

  • hasText(text: TextType, opts?: OptsType): IElementNode<TextType, BooleanType, FilterType>
  • Waits for a PageElement or for all PageElements managed by a PageElementList, PageElementMap or PageElementGroup to have an actual text which equals the expected text.

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

    Parameters

    • text: TextType

      the expected text which is supposed to equal the actual text

    • Optional opts: OptsType

      includes the timeout within which the condition is expected to be met, the interval used to check it and a reverse flag that, if set to true, checks for the condition NOT to be met instead

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

    Returns IElementNode<TextType, BooleanType, FilterType>

isEnabled

  • isEnabled(opts?: OptsType & object): IElementNode<TextType, BooleanType, FilterType>
  • Waits for a PageElement or for all PageElements managed by a PageElementList, PageElementMap or PageElementGroup to be enabled.

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

    Parameters

    • Optional opts: OptsType & object

      includes filterMask which can be used to skip the invocation of the state check function for some or all managed PageElements, the timeout within which the condition is expected to be met and a reverse flag that, if set to true, checks for the condition NOT to be met instead

      If no timeout is specified, PageNode's default timeout is used.

    Returns IElementNode<TextType, BooleanType, FilterType>

isVisible

  • isVisible(opts?: OptsType & object): IElementNode<TextType, BooleanType, FilterType>
  • Waits for a PageElement or for all PageElements managed by a PageElementList, PageElementMap or PageElementGroup to be visible.

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

    Parameters

    • Optional opts: OptsType & object

      includes filterMask which can be used to skip the invocation of the state check function for some or all managed PageElements, the timeout within which the condition is expected to be met and a reverse flag that, if set to true, checks for the condition NOT to be met instead

      If no timeout is specified, PageNode's default timeout is used.

    Returns IElementNode<TextType, BooleanType, FilterType>

Generated using TypeDoc