GTKX

API Reference / @gtkx/testing / WaitForOptions

Type Alias: WaitForOptions ​

WaitForOptions = object

Defined in: packages/testing/src/types.ts:33

Options controlling how asynchronous queries and waits poll for a condition.

Properties ​

interval? ​

optional interval?: number

Defined in: packages/testing/src/types.ts:37

Delay in milliseconds between retries.

onTimeout? ​

optional onTimeout?: (error) => Error

Defined in: packages/testing/src/types.ts:39

Transforms the error thrown when the timeout elapses.

Parameters ​

error ​

Error

Returns ​

Error

stackTraceError? ​

optional stackTraceError?: Error

Defined in: packages/testing/src/types.ts:41

Error whose stack trace attributes the timeout failure to the calling code.

timeout? ​

optional timeout?: number

Defined in: packages/testing/src/types.ts:35

Maximum time in milliseconds to keep retrying before failing.