useTimer API

API reference for the useTimer composable.

Functions

(handler: () => void, options?: TimerOptions) => TimerContext

Creates a reactive timer with pause/resume support.

number | undefined

Duration in milliseconds.

Default: 1000

boolean | undefined

Whether the timer repeats after firing.

Default: false

ShallowRef<number>

Milliseconds left until next fire.

ShallowRef<boolean>

Whether the timer is currently active (started and not stopped).

ShallowRef<boolean>

Whether the timer is currently paused.

() => void

Start the timer. Restarts if already running.

() => void

Stop the timer and reset remaining to full duration.

() => void

Pause the timer, preserving remaining time. No-op if not running.

() => void

Resume from where pause left off. No-op if not paused.