useProjectSettingsQuery() — supabase Function Reference

Architecture documentation for the useProjectSettingsQuery() function in projectApi.ts from the supabase codebase.

Function typescript DocumentationSystem ReferenceGen calls 1 called by 1

Entity Profile

DocumentationSystem→ ReferenceGen→ useProjectSettingsQuery() — supabase Function Reference

Dependency Diagram

graph TD
  f9229b8d_d5c8_bdc3_289d_227ff4720ef0["useProjectSettingsQuery()"]
  f60c05cc_24fd_1ee4_efe7_d25f34a3957d["VariableView()"]
  f60c05cc_24fd_1ee4_efe7_d25f34a3957d -->|calls| f9229b8d_d5c8_bdc3_289d_227ff4720ef0
  0587fe13_1958_9df8_0ec1_7ae7c4ddb9ee["getProjectSettings()"]
  f9229b8d_d5c8_bdc3_289d_227ff4720ef0 -->|calls| 0587fe13_1958_9df8_0ec1_7ae7c4ddb9ee
  style f9229b8d_d5c8_bdc3_289d_227ff4720ef0 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

apps/docs/lib/fetch/projectApi.ts lines 64–77

export function useProjectSettingsQuery<TData = ProjectSettings>(
  { projectRef }: ProjectApiVariables,
  {
    enabled = true,
    ...options
  }: Omit<UseQueryOptions<ProjectSettings, ProjectApiError, TData>, 'queryKey'> = {}
) {
  return useQuery<ProjectSettings, ProjectApiError, TData>({
    queryKey: projectApiKeys.settings(projectRef),
    queryFn: ({ signal }) => getProjectSettings({ projectRef }, signal),
    enabled,
    ...options,
  })
}