Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ValuePageElementMapEventually<Store, K, PageElementType, PageElementOpts, MapType, ValueType>

This class defines all eventually functions of ValuePageElementMap.

template

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

template

K the key names of ValuePageElementMap's $ accessor used to access the map's managed ValuePageElements

template

PageElementType type of the ValuePageElement managed by ValuePageElementMap

template

PageElementOpts type of the opts parameter passed to the constructor function of the ValuePageElements managed by ValuePageElementMap

template

MapType type of the ValuePageElementMap for which ValuePageElementMapEventually defines all eventually functions

template

ValueType type of the values of ValuePageElements managed by ValuePageElementMap

Type parameters

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Protected _node

_node: MapType

the PageNode for which PageNodeEventually defines all eventually functions

Accessors

not

  • get not(): object

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

    Returns object

    • containsValue: function
      • containsValue(values: Partial<Record<K, ValueType>>, opts?: ITimeoutInterval): boolean

      • Returns true if the actual values of all ValuePageElements managed by ValuePageElementMap eventually do not contain the expected values within a specific timeout.

        Parameters

        • values: Partial<Record<K, ValueType>>

          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 boolean

    • hasAnyValue: function

      • Returns true if all ValuePageElements managed by ValuePageElementMap eventually do not have any text within a specific timeout.

        Parameters

        • Default value opts: ITimeoutInterval & IMapFilterMask<K> = {}

          includes a filterMask which can be used to skip the invocation of the hasAnyValue function for some or all managed ValuePageElements, 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 boolean

    • hasValue: function
      • hasValue(values: Partial<Record<K, ValueType>>, opts?: ITimeoutInterval): boolean

      • Returns true if the actual values of all ValuePageElements managed by ValuePageElementMap eventually do not equal the expected values within a specific timeout.

        Parameters

        • values: Partial<Record<K, ValueType>>

          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 boolean

Methods

containsDirectText

  • containsDirectText(directTexts: Partial<Record<K, string>>, opts?: ITimeoutInterval): boolean

  • Returns true if the actual direct texts of all PageElements managed by PageElementMap eventually contain the expected direct texts within a specific timeout.

    Parameters

    • directTexts: Partial<Record<K, string>>

      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 boolean

containsText

  • containsText(texts: Partial<Record<K, string>>, opts?: ITimeoutInterval): boolean

  • Returns true if the actual texts of all PageElements managed by PageElementMap eventually contain the expected texts within a specific timeout.

    Parameters

    • texts: Partial<Record<K, string>>

      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 boolean

containsValue

  • containsValue(values: Partial<Record<K, ValueType>>, opts?: ITimeoutInterval): boolean

  • Returns true if the actual values of all ValuePageElements managed by ValuePageElementMap eventually contain the expected values within a specific timeout.

    Parameters

    • values: Partial<Record<K, ValueType>>

      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 boolean

exists

  • Returns true if all PageElements managed by PageElementMap eventually exist within a specific timeout.

    Parameters

    • Default value opts: ITimeout & IMapFilterMask<K> = {}

      includes a filterMask which can be used to skip the invocation of the exists function for some or all managed PageElements 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 boolean

hasAnyDirectText

  • Returns true if all PageElements managed by PageElementMap eventually have any direct text within a specific timeout.

    Parameters

    • Default value opts: ITimeoutInterval & IMapFilterMask<K> = {}

      includes a filterMask which can be used to skip the invocation of the hasAnyDirectText 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, a PageElement's default timeout is used. If no interval is specified, a PageElement's default interval is used.

    Returns boolean

hasAnyText

  • Returns true if all PageElements managed by PageElementMap eventually have any text within a specific timeout.

    Parameters

    • Default value opts: ITimeoutInterval & IMapFilterMask<K> = {}

      includes a filterMask which can be used to skip the invocation of the hasAnyText 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, a PageElement's default timeout is used. If no interval is specified, a PageElement's default interval is used.

    Returns boolean

hasAnyValue

  • Returns true if all ValuePageElements managed by ValuePageElementMap eventually have any text within a specific timeout.

    Parameters

    • Default value opts: ITimeoutInterval & IMapFilterMask<K> = {}

      includes a filterMask which can be used to skip the invocation of the hasAnyValue function for some or all managed ValuePageElements, 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 boolean

hasDirectText

  • hasDirectText(directTexts: Partial<Record<K, string>>, opts?: ITimeoutInterval): boolean

  • Returns true if the actual direct texts of all PageElements managed by PageElementMap eventually equal the expected direct texts within a specific timeout.

    Parameters

    • directTexts: Partial<Record<K, string>>

      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 boolean

hasText

  • Returns true if the actual texts of all PageElements managed by PageElementMap eventually equal the expected texts within a specific timeout.

    Parameters

    • texts: Partial<Record<K, string>>

      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 boolean

hasValue

  • hasValue(values: Partial<Record<K, ValueType>>, opts?: ITimeoutInterval): boolean

  • Returns true if the actual values of all ValuePageElements managed by ValuePageElementMap eventually equal the expected values within a specific timeout.

    Parameters

    • values: Partial<Record<K, ValueType>>

      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 boolean

isEnabled

  • Returns true if all PageElements managed by PageElementMap eventually are enabled within a specific timeout.

    Parameters

    • Default value opts: ITimeout & IMapFilterMask<K> = {}

      includes a filterMask which can be used to skip the invocation of the isEnabled function for some or all managed PageElements 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 boolean

isVisible

  • Returns true if all PageElements managed by PageElementMap eventually are visible within a specific timeout.

    Parameters

    • Default value opts: ITimeout & IMapFilterMask<K> = {}

      includes a filterMask which can be used to skip the invocation of the isVisible function for some or all managed PageElements 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 boolean

Generated using TypeDoc