Skip to main content

Interface: Waiter

Defined in: packages/core/src/interactor/Interactor.ts:309

Async settling primitives: block until a locator reaches a target state, or until a caller-supplied probe terminates. A capability facet of Interactor (ADR-007).

Extended by​

Methods​

waitUntil()​

waitUntil<T>(option): Promise<T>

Defined in: packages/core/src/interactor/Interactor.ts:328

Keep running a probe function until it returns a value that matches the terminate condition or timeout

Type Parameters​

T​

T

Parameters​

option​

WaitUntilOption<T>

Returns​

Promise<T>

The last value returned by the probe function


waitUntilComponentState()​

waitUntilComponentState(locator, option?): Promise<void>

Defined in: packages/core/src/interactor/Interactor.ts:322

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​

locator​

PartLocator

The locator of the component to wait for

option?​

Partial<Readonly<WaitForOption>>

The option to configure the wait behavior

Returns​

Promise<void>