Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ICustomMapMatchers<K>

This interface describes custom expectation matchers for PageElementMaps.

It can be used for both positive and negative (.not) comparisons.

template

K the names of the elements stored in the map (the map's keys) as string literals

Type parameters

  • K: string

Hierarchy

Index

Methods

Methods

toBeEnabled

  • Checks if all of the PageElements managed by PageElementMap are currently enabled.

    Parameters

    • Optional filterMask: MapFilterMask<K>

      Can be used to skip the check for some or all managed PageElements.

    Returns boolean

toBeVisible

  • Checks if all of the PageElements managed by PageElementMap are currently visible.

    Parameters

    • Optional filterMask: MapFilterMask<K>

      Can be used to skip the check for some or all managed PageElements.

    Returns boolean

toContainDirectText

  • toContainDirectText(directText: Partial<Record<K, string>>): boolean

  • Checks if all of the PageElements managed by PageElementMap currently contain the expected direct text.

    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: Partial<Record<K, string>>

      An object with the names of the corresponding PageElements as keys and the expected contained direct texts as values.

    Returns boolean

toContainText

  • toContainText(text: Partial<Record<K, string>>): boolean

  • Checks if all of the PageElements managed by PageElementMap currently contain the expected text.

    Parameters

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

      An object with the names of the corresponding PageElements as keys and the expected contained texts as values.

    Returns boolean

toEventuallyBeEnabled

  • Checks if all of the PageElements managed by PageElementMap eventually become enabled within a specific timeout.

    Parameters

    • Optional opts: ITimeout & IMapFilterMask<K>

      Includes a filterMask that can be used to skip the check for some or all managed PageElements and the timeout within which the condition is expected to be met.

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

    Returns boolean

toEventuallyBeVisible

  • Checks if all of the PageElements managed by PageElementMap eventually become visible within a specific timeout.

    Parameters

    • Optional opts: ITimeout & IMapFilterMask<K>

      Includes a filterMask that can be used to skip the check for some or all managed PageElements and the timeout within which the condition is expected to be met.

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

    Returns boolean

toEventuallyContainDirectText

  • toEventuallyContainDirectText(directText: Partial<Record<K, string>>, opts?: ITimeoutInterval): boolean

  • Checks if all of the PageElements managed by PageElementMap eventually contain the expected direct text within a specific timeout.

    Parameters

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

      An object with the names of the corresponding PageElements as keys and the expected contained direct texts as 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, PageElementMap's default timeout is used. If no interval is specified, PageElementMap's default interval is used.

    Returns boolean

toEventuallyContainText

  • toEventuallyContainText(text: Partial<Record<K, string>>, opts?: ITimeoutInterval): boolean

  • Checks if all of the PageElements managed by PageElementMap eventually contain the expected text within a specific timeout.

    Parameters

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

      An object with the names of the corresponding PageElements as keys and the expected contained texts as 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, PageElementMap's default timeout is used. If no interval is specified, PageElementMap's default interval is used.

    Returns boolean

toEventuallyExist

  • Checks if all of the PageElements managed by PageElementMap eventually exist within a specific timeout.

    Parameters

    • Optional opts: ITimeout & IMapFilterMask<K>

      Includes a filterMask that can be used to skip the check for some or all managed PageElements and the timeout within which the condition is expected to be met.

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

    Returns boolean

toEventuallyHaveAnyDirectText

  • Checks if all of the PageElements managed by PageElementMap eventually have any direct text within a specific timeout.

    Parameters

    • Optional opts: ITimeoutInterval & IMapFilterMask<K>

      Includes a filterMask that can be used to skip the check 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, PageElementMap's default timeout is used. If no interval is specified, PageElementMap's default interval is used.

    Returns boolean

toEventuallyHaveAnyText

  • Checks if all of the PageElements managed by PageElementMap eventually have any text within a specific timeout.

    Parameters

    • Optional opts: ITimeoutInterval & IMapFilterMask<K>

      Includes a filterMask that can be used to skip the check 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, PageElementMap's default timeout is used. If no interval is specified, PageElementMap's default interval is used.

    Returns boolean

toEventuallyHaveDirectText

  • toEventuallyHaveDirectText(directText: Partial<Record<K, string>>, opts?: ITimeoutInterval): boolean

  • Checks if all of the PageElements managed by PageElementMap eventually have the expected direct text within a specific timeout.

    Parameters

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

      An object with the names of the corresponding PageElements as keys and the expected direct texts as 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, PageElementMap's default timeout is used. If no interval is specified, PageElementMap's default interval is used.

    Returns boolean

toEventuallyHaveText

  • toEventuallyHaveText(text: Partial<Record<K, string>>, opts?: ITimeoutInterval): boolean

  • Checks if all of the PageElements managed by PageElementMap eventually have the expected text within a specific timeout.

    Parameters

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

      An object with the names of the corresponding PageElements as keys and the expected texts as 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, PageElementMap's default timeout is used. If no interval is specified, PageElementMap's default interval is used.

    Returns boolean

toExist

  • Checks if all of the PageElements managed by PageElementMap currently exist.

    Parameters

    • Optional filterMask: MapFilterMask<K>

      Can be used to skip the check for some or all managed PageElements.

    Returns boolean

toHaveAnyDirectText

  • Checks if all of the PageElements managed by PageElementMap currently have any direct text.

    Parameters

    • Optional filterMask: MapFilterMask<K>

      Can be used to skip the check for some or all managed PageElements.

    Returns boolean

toHaveAnyText

  • Checks if all of the PageElements managed by PageElementMap currently have any text.

    Parameters

    • Optional filterMask: MapFilterMask<K>

      Can be used to skip the check for some or all managed PageElements.

    Returns boolean

toHaveDirectText

  • toHaveDirectText(directText: Partial<Record<K, string>>): boolean

  • Checks if all of the PageElements managed by PageElementMap currently have the expected direct text.

    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: Partial<Record<K, string>>

      An object with the names of the corresponding PageElements as keys and the expected direct texts as values.

    Returns boolean

toHaveText

  • toHaveText(text: Partial<Record<K, string>>): boolean

  • Checks if all of the PageElements managed by PageElementMap currently have the expected text.

    Parameters

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

      An object with the names of the corresponding PageElements as keys and the expected texts as values.

    Returns boolean

Generated using TypeDoc