fn
useInterval
v0.0.15testeddemoReactive counter that increments on every interval tick.
Examples
ts
const counter = useInterval(1000);ts
const { counter, isActive, pause, resume, reset } = useInterval(1000, { controls: true });Demo
Loading demo…
Signatures
ts
export function useInterval(interval?: MaybeRefOrGetter<number>, options?: UseIntervalOptions<false>): Readonly<ShallowRef<number>>;ts
export function useInterval(interval: MaybeRefOrGetter<number>, options: UseIntervalOptions<true>): UseIntervalControls;Parameters
| Parameter | Type | Description |
|---|---|---|
interval? | MaybeRefOrGetter<number> | Interval in milliseconds (can be reactive) |
options? | UseIntervalOptions<boolean> | Options |
Returns
UseIntervalReturnThe read-only counter, or controls when `controls: true`