watchUntil

Watches source until callback returns true or another configurable value.

Usage

import { watchUntil } from '@8ctavio/vergil'

watchUntil(src, (v,u) => {
    if (condition(v,u)){
        // ...
        return true  // watchUntil resolves to v
    }
})

Definition

// Single watch source
function watchUntil<T, O extends WatchUntilOptions>(
    source: WatchSource<T>,
    callback: WatchUntilCallback<T,O>,
    options?: O
): Promise<T | undefined>

// Multiple watch sources
function watchUntil<T, O extends WatchUntilOptions>(
    source: WatchSource<T>[],
    callback: WatchUntilCallback<T[], O>,
    options?: O
): Promise<T[] | undefined>

type WatchUntilOptions = {
    fulfill?: unknown;
    timeout?: number;
    signal?: AbortSignal;
    deep?: boolean | number;
    flush?: 'pre' | 'post' | 'sync';
}

type WatchUntilCallback<T, O extends WatchUntilOptions> =
	(...args: Parameters<WatchCallback<T, MaybeUndefined<T>>>) => 
		| (O extends { fulfill: infer F } ? F : boolean)
		| void

Parameters

• fulfill: The return value required to stop the watcher. Defaults to true.
• timeout: Duration of watcher timeout in milliseconds. If set and callback is not fulfilled after timeout milliseconds, the watcher stops.
• signal: AbortSignal to abort watcher with a corresponding AbortController.
• For others, see watch.

Return value

A promise. Resolves to the WatchSource value that fulfilled the callback. If aborted, the promise rejects with the abort signal's abort reason (signal.reason).