Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ICheckWaitValue<ValueType, FilterType, OptsType>

Used by IValueElementNode to describe wait state check functions supported by ValuePageElement, ValuePageElementList, ValuePageElementMap and ValuePageElementGroup.

Type parameters

  • ValueType

  • FilterType

  • OptsType

Hierarchy

  • ICheckWaitValue

Index

Properties

Methods

Properties

not

not: Omit<ICheckWaitValue<ValueType, FilterType, ITimeoutInterval>, "not">

returns the negated variants of ICheckWaitValue's state check functions

Methods

containsValue

  • containsValue(value: ValueType, opts?: OptsType): IValueElementNode<ValueType, FilterType>

  • Waits for a ValuePageElement or for all ValuePageElements managed by a ValuePageElementList, ValuePageElementMap or ValuePageElementGroup to have an actual value which contains the expected value.

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

    Parameters

    • value: ValueType

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

    • 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 IValueElementNode<ValueType, FilterType>

hasAnyValue

  • Waits for a ValuePageElement or for all ValuePageElements managed by a ValuePageElementList, ValuePageElementMap or ValuePageElementGroup to have any value.

    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 IValueElementNode<ValueType, FilterType>

hasValue

  • hasValue(value: ValueType, opts?: OptsType): IValueElementNode<ValueType, FilterType>

  • Waits for a ValuePageElement or for all ValuePageElements managed by a ValuePageElementList, ValuePageElementMap or ValuePageElementGroup to have an actual value which equals the expected value.

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

    Parameters

    • value: ValueType

      the expected value which is supposed to equal the actual value

    • 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 IValueElementNode<ValueType, FilterType>

Generated using TypeDoc