Class ZCircusDriver

Represents the circus driver for selenium actions.

Implements

IZCircusDriver

Index

Constructors

constructor

Methods

attribute body classes disabled focused peek perform query select selected tag text value wait

Constructors

constructor

new ZCircusDriver(_seleniumDriver, _search): ZCircusDriver
Initializes a new instance of this object.
Parameters
- _seleniumDriver: WebDriver
  The underlying web driver.
- _search: WebElement
  The search context.
Returns ZCircusDriver
- Defined in driver/circus-driver.mts:23

Methods

attribute

attribute<T>(attribute): Promise<null | T>
Returns an attribute of the driver.
Type Parameters
- T extends string
Parameters
- attribute: string
  The attribute to retrieve.
Returns Promise<null | T>
The attribute value, or null if no such value exists.
Implementation of IZCircusDriver.attribute
- Defined in driver/circus-driver.mts:28
attribute<T>(attribute, fallback): Promise<T>
Returns an attribute of the driver.
Type Parameters
- T extends string
Parameters
- attribute: string
  The attribute to retrieve.
- fallback: T
Returns Promise<T>
The attribute value, or null if no such value exists.
Implementation of IZCircusDriver.attribute
- Defined in driver/circus-driver.mts:30

body

body(): Promise<IZCircusDriver>
Jumps to the body element.

This is useful if you are opening modals and popups that don't exist from withing the driver context.

Returns Promise<IZCircusDriver>
A new driver that contains the document body as the context.
Implementation of IZCircusDriver.body
- Defined in driver/circus-driver.mts:95

classes

classes(filter?): Promise<string[]>
Returns a list of classes on the driver context that match a given filter.
Parameters
- Optionalfilter: string[]
  The filter of classes you want to check for. If you just want to get all classes, then just use undefined here.
Returns Promise<string[]>
The list of classes that match the filter.
Implementation of IZCircusDriver.classes
- Defined in driver/circus-driver.mts:43

disabled

disabled(): Promise<boolean>
Gets whether the context described by this driver is disabled.

Returns Promise<boolean>
True if the driver context is disabled. False if enabled.
Implementation of IZCircusDriver.disabled
- Defined in driver/circus-driver.mts:75

focused

focused(): Promise<null | IZCircusDriver>
Jumps to the focused element.

Returns Promise<null | IZCircusDriver>
A new driver that contains the focused element, or null if there is no element focused.
Implementation of IZCircusDriver.focused
- Defined in driver/circus-driver.mts:100

peek

peek(selector): Promise<boolean>
Looks at the app structure to see if a css selector will produce any results.
Parameters
- selector: string
  The selector to check.
Returns Promise<boolean>
True if the selector will result in one or more results. False otherwise.
Implementation of IZCircusDriver.peek
- Defined in driver/circus-driver.mts:80

perform

perform(act): Promise<void>
Performs an action against the driver context.
Parameters
- act: IZCircusAct
  The act to perform.
Returns Promise<void>
Implementation of IZCircusDriver.perform
- Defined in driver/circus-driver.mts:105

query

query(selector): Promise<IZCircusDriver[]>
Selects all items under this driver that matches the css selector.
Parameters
- selector: string
  The selector to query.
Returns Promise<IZCircusDriver[]>
A promise that resolves with all items found from the selector. If no items are found, then an empty array is returned.
Implementation of IZCircusDriver.query
- Defined in driver/circus-driver.mts:90

select

select(selector): Promise<IZCircusDriver>
Selects a single item under the driver that matches the css selector.
Parameters
- selector: string
  The selector to query.
Returns Promise<IZCircusDriver>
A resolved promise with the first item found if the selector produces one or more results. Returns a rejected promise if the selector returns no items.
Implementation of IZCircusDriver.select
- Defined in driver/circus-driver.mts:85

selected

selected(): Promise<boolean>
Gets whether the value of the driver context is selected.

Returns Promise<boolean>
True if the context is in a selected state. False otherwise.
Implementation of IZCircusDriver.selected
- Defined in driver/circus-driver.mts:71

text

text(): Promise<string>
Gets the underlying text of the driver context.

Returns Promise<string>
The underlying text of the driver context. Returns the empty string if no text exists.
Implementation of IZCircusDriver.text
- Defined in driver/circus-driver.mts:58

value

value(fallback): Promise<string>
Gets the underlying value of the driver context.
Parameters
- fallback: string
  The fallback value in the case that the driver does not support a value.
Returns Promise<string>
The underlying value of the driver context, or fallback if the driver does not support a value.
Implementation of IZCircusDriver.value
- Defined in driver/circus-driver.mts:62
value(): Promise<null | string>
Gets the underlying value of the driver context.

Returns Promise<null | string>
The underlying value of the driver context, or fallback if the driver does not support a value.
Implementation of IZCircusDriver.value
- Defined in driver/circus-driver.mts:64

wait

wait(predicate, options?): Promise<void>
Waits for a certain condition to be met before continuing.
Parameters
- predicate: (() => boolean | Promise<boolean>)
  The predicate to wait for.
  - - (): boolean | Promise<boolean>
    - Returns boolean | Promise<boolean>
- Optionaloptions: IZCircusWaitOptions
  The options for the wait.
Returns Promise<void>
Implementation of IZCircusDriver.wait
- Defined in driver/circus-driver.mts:124

Class ZCircusDriver

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns ZCircusDriver

Methods

attribute

Type Parameters

Parameters

Returns Promise<null | T>

Type Parameters

Parameters

Returns Promise<T>

body

Returns Promise<IZCircusDriver>

classes

Parameters

Returns Promise<string[]>

disabled

Returns Promise<boolean>

focused

Returns Promise<null | IZCircusDriver>

peek

Parameters

Returns Promise<boolean>

perform

Parameters

Returns Promise<void>

query

Parameters

Returns Promise<IZCircusDriver[]>

select

Parameters

Returns Promise<IZCircusDriver>

selected

Returns Promise<boolean>

tag

Returns Promise<string>

text

Returns Promise<string>

value

Parameters

Returns Promise<string>

Returns Promise<null | string>

wait

Parameters

Returns boolean | Promise<boolean>

Returns Promise<void>

Settings

On This Page