peter
e257e2aca0
Prettier 3 (pinned), printWidth 100, double quotes — chosen to match the existing hand-formatting and minimise reflow. This commit is ONLY the mechanical format pass (`prettier --write`) plus the config/ignore/scripts, isolated so it never pollutes a feature diff. Verified behaviour-neutral: typecheck, eslint (0 errors), and vitest all green before and after. See .git-blame-ignore-revs — `git blame` skips this sha.
31 lines
1.3 KiB
TypeScript
31 lines
1.3 KiB
TypeScript
import { useQuery, type QueryKey } from "@tanstack/react-query";
|
|
|
|
// Reusable "live" polling query: a thin wrapper over react-query that refetches on an
|
|
// interval and — by leaving refetchIntervalInBackground at its default false — pauses while
|
|
// the tab is unfocused, so it doesn't poll a server nobody's watching. This is the shared
|
|
// live-progress mechanism: the Scheduler dashboard uses it now; the notification bell and the
|
|
// future yt-dlp job queue reuse it rather than each re-implementing polling.
|
|
export function useLiveQuery<T>(
|
|
key: QueryKey,
|
|
queryFn: () => Promise<T>,
|
|
// intervalMs may be a function of the latest data, so the poll cadence can adapt to it
|
|
// (e.g. poll faster while a job is running). react-query re-evaluates it after each fetch
|
|
// against fresh data — the right place for this, vs. a React state toggle that can lag or
|
|
// stall the live updates.
|
|
opts: { intervalMs?: number | ((data: T | undefined) => number); enabled?: boolean } = {},
|
|
) {
|
|
const { intervalMs = 4000, enabled = true } = opts;
|
|
return useQuery({
|
|
queryKey: key,
|
|
queryFn,
|
|
enabled,
|
|
refetchInterval: !enabled
|
|
? false
|
|
: typeof intervalMs === "function"
|
|
? (query) => intervalMs(query.state.data as T | undefined)
|
|
: intervalMs,
|
|
refetchIntervalInBackground: false,
|
|
staleTime: 0,
|
|
});
|
|
}
|