Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Page<Store, IsOpenOpts, IsClosedOpts>

This class serves as the base class for all Pages.

It provides the functions isOpen and isClosed to check if the page currently is open or closed. Page also features a wait API to wait for the page to be open or closed and an eventually API to check if the page eventually is open or closed.

Contrary to PageNode, Page does not have an initial waiting condition. Therefore, Page has no currently API (unlike PageElement) because all functions defined directly on Page (and not on its wait or eventually APIs) always describe the current state of the page.

template

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

template

IsOpenOpts type of the opts parameter passed to the functions isOpen, wait.isOpen and eventually.isOpen

template

IsClosedOpts type of the opts parameter passed to the functions isClosed, wait.isClosed and eventually.isClosed

Type parameters

Hierarchy

  • Page

Implements

  • IPage<Store, IsOpenOpts, IsClosedOpts>

Index

Constructors

constructor

Properties

Protected _interval

_interval: number

the default interval in milliseconds used by Page for its wait and eventually functions.

Protected _lastTimeout

_lastTimeout: number

Stores the last timeout used by Page's wait and eventually functions.

Intended for framework-internal usage only.

Protected _store

_store: Store

an instance of PageNodeStore which can be used to retrieve/create PageNodes via Page

Protected _timeout

_timeout: number

the default timeout in milliseconds used by Page for its wait and eventually functions.

eventually

eventually: PageEventually<Store, this, IsOpenOpts, IsClosedOpts>

wait

wait: PageWait<Store, this, IsOpenOpts, IsClosedOpts>

Accessors

__lastTimeout

  • get __lastTimeout(): number

Methods

__setLastTimeout

  • __setLastTimeout(timeout: number): void

getInterval

  • getInterval(): number

getStore

  • getStore(): Store

getTimeout

  • getTimeout(): number

Abstract isClosed

  • isClosed(opts?: IsClosedOpts): boolean

Abstract isOpen

  • isOpen(opts?: IsOpenOpts): boolean

toJSON

Generated using TypeDoc