Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PageEventually<Store, PageType, IsOpenOpts, IsClosedOpts>

This class defines all eventually functions of a Page.

template

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

template

PageType type of the Page for which PageEventually defines all eventually functions

template

IsOpenOpts type of the opts parameter passed to the function isOpen

template

IsClosedOpts type of the opts parameter passed to the functions isClosed

Type parameters

  • Store: PageNodeStore

  • PageType: Page<Store, IsOpenOpts, IsClosedOpts>

  • IsOpenOpts: object

  • IsClosedOpts: object

Hierarchy

  • PageEventually

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected _page

_page: PageType

the Page for which PageEventually defines all eventually functions

Methods

Protected _eventually

  • A function which provides common functionality to check if certain conditionFunc eventually returns true within a specific timeout.

    Parameters

    • conditionFunc: function

      the condition which is expected to return true within a specific timeout

        • (): boolean

        • Returns boolean

    • Default value opts: ITimeoutInterval = Object.create(null)

      includes the timeout within which the condition is expected to return true and the interval used to check for this condition.

      If no timeout is specified, the Page's default timeout is used instead. If no interval is specified, the Page's default interval is used instead.

    Returns boolean

isClosed

  • Checks if Page eventually becomes closed within a specific timeout.

    Parameters

    • Default value opts: IsClosedOpts & ITimeoutInterval = Object.create(null)

      includes the options defined in IsClosedOpts, the timeout within which the Page must become closed and the interval used to check for this condition.

      If no timeout is specified, the Page's default timeout is used instead. If no interval is specified, the Page's default interval is used instead.

    Returns boolean

isOpen

  • Checks if Page eventually becomes open within a specific timeout.

    Parameters

    • Default value opts: IsOpenOpts & ITimeoutInterval = Object.create(null)

      includes the options defined in IsOpenOpts, the timeout within which the Page must become open and the interval used to check for this condition.

      If no timeout is specified, the Page's default timeout is used instead. If no interval is specified, the Page's default interval is used instead.

    Returns boolean

Generated using TypeDoc