MCPcopy
hub / github.com/umami-software/umami / usePagedQuery

Function usePagedQuery

src/components/hooks/usePagedQuery.ts:6–27  ·  view source on GitHub ↗
({
  queryKey,
  queryFn,
  ...options
}: Omit<
  UseQueryOptions<PageResult<TData>, TError, PageResult<TData>, readonly unknown[]>,
  'queryFn' | 'queryKey'
> & {
  queryKey: readonly unknown[];
  queryFn: (params?: object) => Promise<PageResult<TData>> | PageResult<TData>;
})

Source from the content-addressed store, hash-verified

4import { useNavigation } from './useNavigation';
5
6export function usePagedQuery<TData = any, TError = Error>({
7 queryKey,
8 queryFn,
9 ...options
10}: Omit<
11 UseQueryOptions<PageResult<TData>, TError, PageResult<TData>, readonly unknown[]>,
12 'queryFn' | 'queryKey'
13> & {
14 queryKey: readonly unknown[];
15 queryFn: (params?: object) => Promise<PageResult<TData>> | PageResult<TData>;
16}): UseQueryResult<PageResult<TData>, TError> {
17 const {
18 query: { page, search, orderBy, sortDescending },
19 } = useNavigation();
20 const { useQuery } = useApi();
21
22 return useQuery<PageResult<TData>, TError>({
23 queryKey: [...queryKey, page, search, orderBy, sortDescending] as const,
24 queryFn: () => queryFn({ page, search, orderBy, sortDescending }),
25 ...options,
26 });
27}

Callers 15

useReportsQueryFunction · 0.90
useRevenueSessionsQueryFunction · 0.90
useWebsiteSessionsQueryFunction · 0.90
useWebsiteEventsQueryFunction · 0.90
useReplaysQueryFunction · 0.90
useLinksQueryFunction · 0.90
usePixelSharesQueryFunction · 0.90
useWebsitesQueryFunction · 0.90
useTeamsQueryFunction · 0.90
useUserWebsitesQueryFunction · 0.90
useUsersQueryFunction · 0.90
useTeamMembersQueryFunction · 0.90

Calls 2

useNavigationFunction · 0.90
useApiFunction · 0.90

Tested by

no test coverage detected