Interface WaitOptions

interface WaitOptions {
    continueWaitingOnFailure?: TypeOrDeferredType<boolean>;
    continueWaitingOnReset?: TypeOrDeferredType<boolean>;
    timeoutMSec?: number;
}

Hierarchy (view full)

Properties

continueWaitingOnFailure?: TypeOrDeferredType<boolean>

Checked if a failure occurs while waiting. If true, continues waiting. Otherwise, stops waiting and the wait function returns 'failure'

Default Value

false

continueWaitingOnReset?: TypeOrDeferredType<boolean>

Checked if a reset occurs while waiting. If true, continues waiting. Otherwise, stops waiting and the wait function returns 'reset'

Default Value

true

timeoutMSec?: number

If specified, the interval after which the wait function will resolve with 'timeout' if the waitable is still incomplete.

Default Value

unlimited

Generated using TypeDoc