useIntervalFn

testeddemo

Call a function on every interval. Supports reactive interval duration, pause/resume, and automatic cleanup on scope dispose.

Source Tests

Examples

const { pause, resume, isActive } = useIntervalFn(() => {
  console.log('tick');
}, 1000);

// Reactive interval
const delay = ref(1000);
useIntervalFn(() => console.log('tick'), delay);
delay.value = 500; // interval restarts with new duration

Demo

Loading demo…

Signature

export function useIntervalFn(
  callback: () => void,
  interval: MaybeRefOrGetter<number> = 1000,
  options: UseIntervalFnOptions ={ ... }

Parameters

Parameter	Type	Default	Description
`callback`	`() => void`	—	Function to call on every interval tick
`interval`?	`MaybeRefOrGetter<number>`	`1000`	Function to call on every interval tick
`options`?	`UseIntervalFnOptions`	`{}`	Configuration options

Returns

UseIntervalFnReturn