Skip to content

WaitUntilParams

Parameters for CommonArguments.waitUntil.

Import:

import type { WaitUntilParams } from 'obsidian-integration-testing';

Signature:

export interface WaitUntilParams

Properties

PropertyTypeDescription
intervalInMilliseconds?numberThe polling interval between predicate checks.
message?stringAn optional detail appended to the timeout error message, describing what was being waited for.
timeoutInMilliseconds?numberThe maximum time to wait before rejecting.

Methods

MethodReturnsDescription
predicate(this)boolean | Promise<boolean>The condition to wait for. Polled immediately, then on every interval until it returns a truthy value. May be synchronous or asynchronous — it is awaited on each poll.