Skip to main content

Interface: ITestEngine<T>

Defined in: packages/core/src/partTypes.ts:204

Extends​

Type Parameters​

T​

T extends ScenePart = { }

Methods​

cleanUp()​

cleanUp(): Promise<void>

Defined in: packages/core/src/partTypes.ts:205

Returns​

Promise<void>

Inherited members (6)

Properties​

locator​

readonly locator: PartLocator

Defined in: packages/core/src/partTypes.ts:166

The locator which helps locate the root of the component

Inherited from​

IComponentDriver.locator


parts​

readonly parts: ScenePartDriver<T>

Defined in: packages/core/src/partTypes.ts:161

Return driver instance of all the named parts

Inherited from​

IComponentDriver.parts

Methods​

exists()​

exists(): Promise<boolean>

Defined in: packages/core/src/partTypes.ts:178

Whether the component exists/attached to the DOM

Returns​

Promise<boolean>

true if the component is attached to the DOM, false otherwise

Inherited from​

IComponentDriver.exists


getText()​

getText(): Promise<Optional<string>>

Defined in: packages/core/src/partTypes.ts:172

Get the combined text content of the component

Returns​

Promise<Optional<string>>

If the component exists and has content, it should return the text or otherwise undefined

Inherited from​

IComponentDriver.getText


isVisible()​

isVisible(): Promise<boolean>

Defined in: packages/core/src/partTypes.ts:188

Whether the component is visible. Visibility is defined that the component does not have the CSS property display: none, visibility: hidden, or opacity: 0. However this does not check whether the component is within the viewport.

Returns​

Promise<boolean>

true if the component is visible, false otherwise

Inherited from​

IComponentDriver.isVisible


waitUntilComponentState()​

waitUntilComponentState(option?): Promise<void>

Defined in: packages/core/src/partTypes.ts:201

Wait until the component is in the expected state such as the component's visibility or existence. If the component has not reached the expected state within the timeout, it will throw an error.

By default it waits until the component is attached to the DOM within 30 seconds.

Parameters​
option?​

Partial<Readonly<WaitForOption>>

The option to configure the wait behavior

Returns​

Promise<void>

Inherited from​

IComponentDriver.waitUntilComponentState