Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ICheckEventually<TextType, BooleanType, FilterType>

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

Type parameters

  • TextType

  • BooleanType

  • FilterType

Hierarchy

  • ICheckEventually

Index

Properties

Methods

Properties

not

not: Omit<ICheckEventually<TextType, BooleanType, FilterType>, "not">

returns the negated variants of ICheckEventually's state check functions

Methods

containsDirectText

  • Checks if a PageElement or all PageElements managed by a PageElementList, PageElementMap or PageElementGroup eventually have an actual direct text which contains the expected direct text 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

    • text: TextType
    • 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, PageNode's default timeout is used. If no interval is specified, PageNode's default interval is used.

    Returns boolean

containsText

  • Checks if a PageElement or all PageElements managed by a PageElementList, PageElementMap or PageElementGroup eventually have an actual text which contains the expected text within a specific timeout.

    Parameters

    • text: TextType

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

    • 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, PageNode's default timeout is used. If no interval is specified, PageNode's default interval is used.

    Returns boolean

exists

  • exists(opts?: ITimeout & object): boolean

  • Checks if a PageElement or all PageElements managed by a PageElementList, PageElementMap or PageElementGroup eventually exist within a specific timeout.

    Parameters

    • Optional opts: ITimeout & object

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

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

    Returns boolean

hasAnyDirectText

  • Checks if a PageElement or all PageElements managed by a PageElementList, PageElementMap or PageElementGroup eventually have any direct text 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

    • Optional opts: ITimeoutInterval & 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 the interval used to check it

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

    Returns boolean

hasAnyText

  • Checks if a PageElement or all PageElements managed by a PageElementList, PageElementMap or PageElementGroup eventually have any text within a specific timeout.

    Parameters

    • Optional opts: ITimeoutInterval & 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 the interval used to check it

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

    Returns boolean

hasDirectText

  • Checks if a PageElement or all PageElements managed by a PageElementList, PageElementMap or PageElementGroup eventually have an actual direct text which equals the expected direct text 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

    • text: TextType
    • 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, PageNode's default timeout is used. If no interval is specified, PageNode's default interval is used.

    Returns boolean

hasText

  • Checks if a PageElement or all PageElements managed by a PageElementList, PageElementMap or PageElementGroup eventually have an actual text which equals the expected text within a specific timeout.

    Parameters

    • text: TextType

      the expected text which is supposed to equal the actual text

    • 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, PageNode's default timeout is used. If no interval is specified, PageNode's default interval is used.

    Returns boolean

isEnabled

  • isEnabled(opts?: ITimeout & object): boolean

  • Checks if a PageElement or all PageElements managed by a PageElementList, PageElementMap or PageElementGroup eventually becomes enabled within a specific timeout.

    Parameters

    • Optional opts: ITimeout & object

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

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

    Returns boolean

isVisible

  • isVisible(opts?: ITimeout & object): boolean

  • Checks if a PageElement or all PageElements managed by a PageElementList, PageElementMap or PageElementGroup eventually becomes visible within a specific timeout.

    Parameters

    • Optional opts: ITimeout & object

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

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

    Returns boolean

Generated using TypeDoc