Function useCountdown

useCountdown(
    active: BreakEvent | null,
    remaining: number,
    paused: boolean,
    appearance: OverlaySettings,
    setRemaining: (next: number | ((prev: number) => number)) => void,
    setFinished: (next: boolean) => void,
    clearBreak: () => void,
    deps?: CountdownDeps,
): CountdownApi
Drives the per-second countdown. When remaining hits zero the configured end-chime plays, the IPC end_break call fires, and clearBreak() runs. The end-chime config is captured via a ref so mid-break setting changes are picked up without re-arming the 1-second timer on every appearance change.
Parameters
- active: BreakEvent | null
- remaining: number
- paused: boolean
- appearance: OverlaySettings
- setRemaining: (next: number | ((prev: number) => number)) => void
- setFinished: (next: boolean) => void
- clearBreak: () => void
- deps: CountdownDeps = {}
Returns CountdownApi
- Defined in src/views/break-overlay/hooks/use-countdown.ts:46