useProjectsInfiniteQuery() — supabase Function Reference

Architecture documentation for the useProjectsInfiniteQuery() function in projects-infinite.ts from the supabase codebase.

Function typescript DocumentationSystem ReferenceGen calls 1 called by 2

Entity Profile

DocumentationSystem→ ReferenceGen→ useProjectsInfiniteQuery() — supabase Function Reference

Dependency Diagram

graph TD
  b510335d_4ef5_173b_d8f3_49e057a79d53["useProjectsInfiniteQuery()"]
  379c9577_c27e_ab8c_cd03_c220f0827974["OrgProjectSelector()"]
  379c9577_c27e_ab8c_cd03_c220f0827974 -->|calls| b510335d_4ef5_173b_d8f3_49e057a79d53
  8c9f4578_cfa6_e337_1047_0b169262ad94["ProjectSelector()"]
  8c9f4578_cfa6_e337_1047_0b169262ad94 -->|calls| b510335d_4ef5_173b_d8f3_49e057a79d53
  e2b02433_633a_dc43_ff3a_acbadabb78ee["getProjects()"]
  b510335d_4ef5_173b_d8f3_49e057a79d53 -->|calls| e2b02433_633a_dc43_ff3a_acbadabb78ee
  style b510335d_4ef5_173b_d8f3_49e057a79d53 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

apps/docs/lib/fetch/projects-infinite.ts lines 52–82

export const useProjectsInfiniteQuery = <
  TData = { pages: ProjectsInfiniteData[]; pageParams: number[] },
>(
  { limit = DEFAULT_LIMIT, sort = 'name_asc', search }: GetProjectsInfiniteVariables,
  {
    enabled = true,
    ...options
  }: Omit<
    UseInfiniteQueryOptions<ProjectsInfiniteData, ProjectsInfiniteError, TData>,
    'queryKey' | 'getNextPageParam' | 'initialPageParam'
  >
) => {
  return useInfiniteQuery<ProjectsInfiniteData, ProjectsInfiniteError, TData>({
    enabled,
    queryKey: projectKeys.listInfinite({ limit, sort, search }),
    queryFn: ({ signal, pageParam }) =>
      getProjects({ limit, page: pageParam as any, sort, search }, signal),
    initialPageParam: 0,
    getNextPageParam(lastPage, pages) {
      const page = pages.length
      const currentTotalCount = page * limit
      // @ts-ignore [Joshen] API type issue for Version 2 endpoints
      const totalCount = lastPage.pagination.count

      if (currentTotalCount >= totalCount) return undefined
      return page
    },
    staleTime: 30 * 60 * 1000, // 30 minutes
    ...options,
  })
}