API Docs for: 0.9.1
Show:

BaseObject Class

Extends Base
Defined in: lib/baseObject.js:13

Methods

addLoadSelector

(
  • selector
)
BaseObject

Defined in lib/pageObjects/baseObject.js:81

Adds a single load selector, elements that should be selected when object is loaded

Parameters:

Returns:

BaseObject:

addLoadSelectors

(
  • selectors
)
BaseObject

Defined in lib/pageObjects/baseObject.js:67

Adds multiple load selectors, elements that should be selected when object is loaded

Parameters:

Returns:

BaseObject:

blackOut

() Object[]

Defined in lib/pageObjects/baseObject.js:280

List of blackout coordinates for the current page-object

Returns:

Object[]:

capture

(
  • title
  • [id='1']
  • [wait=1000]
  • [additionalBlackOuts]
)
Promise

Defined in lib/pageObjects/baseObject.js:290

Captures the current page-object

Parameters:

  • title String

    Title of test or part of identifier

  • [id='1'] String optional

    Identifier for screenshot file

  • [wait=1000] Int optional

    Wait before a screenshot is taken

  • [additionalBlackOuts] Object[] optional

    Additional black-outs

Returns:

Promise:

getAdapter

() DriverAdapter

Defined in lib/pageObjects/baseObject.js:107

Gets the web-driver adapter

Returns:

DriverAdapter:

getContext

() Element

Defined in lib/pageObjects/baseObject.js:97

Get the page-object context

Returns:

Element:

getDriverAdapter

() DriverAdapter static

Defined in lib/pageObjects/baseObject.js:406

Gets the web-driver adapter

Returns:

DriverAdapter:

getElement

(
  • selectorName
)
Element

Defined in lib/pageObjects/baseObject.js:163

Gets an element by a selector name

Parameters:

Returns:

Element:

getFrame

(
  • [selectorName]
)
Object

Defined in lib/pageObjects/baseObject.js:256

Get the coordinates and size of an element

Parameters:

  • [selectorName] String optional

    Defaults to current context

Returns:

Object:

{x: int, y: int, width: int, height: int}

getScreenshotPath

() String static

Defined in lib/pageObjects/baseObject.js:384

Gets the path for the screenshot results

Returns:

String:

getScreenshotPrefix

() String static

Defined in lib/pageObjects/baseObject.js:395

Gets the screenshot prefix

Returns:

String:

getSelector

(
  • selectorName
)
String

Defined in lib/pageObjects/baseObject.js:138

Gets a specific selector by name

Parameters:

Returns:

String:

getSelectors

() Object

Defined in lib/pageObjects/baseObject.js:118

Get a list of all selectors

Returns:

Object:

hasElement

(
  • selectorName
)
Boolean

Defined in lib/pageObjects/baseObject.js:177

Checks if a selector name does exist in the selector list

Parameters:

Returns:

Boolean:

hasSelector

(
  • selectorName
)
Boolean

Defined in lib/pageObjects/baseObject.js:150

Does it have a specific selector by name

Parameters:

Returns:

Boolean:

initialize

()

Defined in lib/pageObjects/baseObject.js:44

Initializes the base-object

setSelectors

(
  • selectors
)

Defined in lib/pageObjects/baseObject.js:128

Sets the selectors

Parameters:

verifyIsLoaded

(
  • [timeOut]
  • [waitInMs]
)
BaseObject

Defined in lib/pageObjects/baseObject.js:54

Verifies that the page-object and its sub-dom-elements are loaded as expected

Parameters:

  • [timeOut] Int optional
  • [waitInMs] Int optional

Returns:

BaseObject:

waitForElements

(
  • selectors
  • [timeOut=10000]
  • [waitInMs=500]
)
BaseObject

Defined in lib/pageObjects/baseObject.js:191

Waits for the element to appear on the page

Parameters:

  • selectors String[]
  • [timeOut=10000] Int optional
  • [waitInMs=500] Int optional

Returns:

BaseObject:

waitUntil

(
  • fn
  • [timeOut=10000]
  • [waitInMs=500]
)
BaseObject

Defined in lib/pageObjects/baseObject.js:220

Wait until a callback returns a truthy value

Parameters:

  • fn Function
  • [timeOut=10000] Int optional
  • [waitInMs=500] Int optional

Returns:

BaseObject:

Properties

TYPE

String static

Defined in lib/pageObjects/baseObject.js:377