useTimeout

v0.0.15testeddemo

Reactive boolean that flips to `true` after a given delay. Built on `useTimeoutFn`; optionally exposes `start`/`stop` controls. SSR-safe.

Examples

const ready = useTimeout(1000);
// `ready.value` becomes true after 1s

const { ready, start, stop } = useTimeout(1000, { controls: true });

// Run a callback when the timeout elapses
useTimeout(5000, { callback: refresh });

Loading demo…

export function useTimeout(interval?: MaybeRefOrGetter<number>, options?: UseTimeoutOptions<false>): ComputedRef<boolean>;

export function useTimeout(interval: MaybeRefOrGetter<number>, options: UseTimeoutOptions<true>): UseTimeoutControls;

Parameter	Type	Default	Description
`interval`?	`MaybeRefOrGetter<number>`	`1000`	Delay in milliseconds (resolved each time the timeout starts, can be reactive)
`options`?	`UseTimeoutOptions<boolean>`	`{}`	Options

UseTimeoutReturnThe read-only `ready` flag, or controls when `controls: true`