whenever

v0.0.15testeddemo

Shorthand for watching a source to be truthy. Behaves like `watch`, but the callback only fires when the resolved value is truthy.

Examples

const ready = ref(false);
whenever(ready, () => console.log('ready!'));

whenever(() => count.value > 5, () => console.log('over five'), { once: true });

Loading demo…

export function whenever<T>(source: WatchSource<T>, cb: WatchCallback<Truthy<T>, T | undefined>, options?: WheneverOptions<true>): WatchHandle;

export function whenever<T>(source: WatchSource<T>, cb: WatchCallback<Truthy<T>, T>, options?: WheneverOptions<false>): WatchHandle;

T

Parameter	Type	Default	Description
`source`	`WatchSource<T>`	—	The reactive source to watch
`cb`	`WatchCallback<Truthy<T>, T \| undefined>`	—	Invoked with the truthy value, previous value, and `onCleanup`
`options`?	`WheneverOptions<boolean> \| undefined`	—	Watch options (`immediate`, `deep`, `flush`, `once`)

WatchHandleA handle to stop watching