WaitFor

@webda/utils

---

Function: WaitFor()

WaitFor<T>(callback, retries, title?, logger?, delayer?): Promise<T>

Defined in: packages/utils/src/waiter.ts:132

Poll an async callback until it resolves the promise itself, returns true, or the retry limit is reached.

Some AWS APIs require minutes of polling. This method calls callback repeatedly until it returns true (or calls resolve), or until retries is exhausted — in which case the returned Promise rejects with a timeout message.

Type Parameters

T

T = any

Parameters

callback

(resolve, reject?) => Promise<boolean>

Called on each attempt. Receives resolve and reject to settle early. Return true to signal success without calling resolve.

retries

number

Maximum number of polling attempts.

title?

string

Optional label used for logging and timeout error messages.

logger?

Logger

Optional logger for progress reporting.

delayer?

WaitDelayer

Delay strategy between calls (default: WaitExponentialDelay(1000)).

Returns

Promise<T>

A Promise that resolves with the value passed to resolve, or rejects on timeout.