Skip to main content

Interface: WaitUntilOption<T>

Defined in: packages/core/src/utils/timingUtil.ts:14

Type Parameters​

T​

T

Properties​

debug?​

optional debug: boolean

Defined in: packages/core/src/utils/timingUtil.ts:36

Whether it should log the conditional checks while waiting

probeCount?​

optional probeCount: number

Defined in: packages/core/src/utils/timingUtil.ts:32

The number of times to probe before timing out. The interval between probes is calculated as timeoutMs / probeCount. Higher values mean more frequent checks.

Default​

10

probeFn()​

probeFn: () => T | Promise<T>

Defined in: packages/core/src/utils/timingUtil.ts:18

A function that returns a value or promised value to be checked against the terminate condition

Returns​

T | Promise<T>

terminateCondition​

terminateCondition: T | (currentValue) => boolean

Defined in: packages/core/src/utils/timingUtil.ts:22

A value to check for equality or a function used for custom equality check

timeoutMs​

timeoutMs: number

Defined in: packages/core/src/utils/timingUtil.ts:26

A number of milliseconds to wait before returning the last value