Skip to content

WaitUntilParams

Parameters for Lib.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.
predicate(this: void) => 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.
timeoutInMilliseconds?numberThe maximum time to wait before rejecting.

Links to this page: