Skip to main content

useRecentAlarms

Loads a recent alarm summary, optionally bounded by count.

When to use it​

Omit count to use the service default; use the alarm-list hook for filtering or paging.

Setup​

Call it from a client-side React component below OvokProvider so it uses the client configured at that provider boundary.

Hook arguments​

ArgumentTypeDetails
count (optional)numberOptional result limit; omission uses service defaults.

TypeScript signature​

(count?: number): OvokRequestState<SlimRecentAlarms>

Request state​

The response payload is SlimRecentAlarms. A successful empty result, a failed request, and a request that has not returned data are distinct states.

FieldMeaning
dataLatest successful response, or undefined before one is available.
loadingWhether the request is in progress.
errorRequest error as an Error, or undefined when no request has failed.
reloadRepeats the request with the current arguments.

Request behavior​

The hook loads when its required inputs are available and reloads when those inputs change. Use reload for an explicit refresh; render loading, error, and successful no-result states separately.

Example​

Handle the hook's loading and error states before rendering the result.

import { useRecentAlarms } from '@ovok/core';

export function RecentAlarmsExample({ count }: { count?: Parameters<typeof useRecentAlarms>[0] }) {
  const { data, loading, error, reload } = useRecentAlarms(count);
  if (loading) return <p>Loading…</p>;
  if (error) return <p role="alert">{error.message}</p>;
  return <section><button onClick={reload}>Reload</button><pre>{JSON.stringify(data, null, 2)}</pre></section>;
}