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:45

Whether it should log the conditional checks while waiting

probeCount?​

optional probeCount?: number

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

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

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>

probeIntervals?​

optional probeIntervals?: readonly number[]

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

Escalating waits (in milliseconds) between probes; the last entry repeats until timeoutMs elapses. Suits "settle a re-render" waits where the condition usually flips within milliseconds but may occasionally take much longer — probe densely first, then back off — whereas the probeCount cadence spreads probes evenly across the full timeout. Takes precedence over probeCount.

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