getProjectSettings() — supabase Function Reference

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

Function typescript DocumentationSystem ReferenceGen called by 1

Entity Profile

DocumentationSystem→ ReferenceGen→ getProjectSettings() — supabase Function Reference

Dependency Diagram

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

Relationship Graph

Source Code

apps/docs/lib/fetch/projectApi.ts lines 34–47

async function getProjectSettings({ projectRef }: ProjectApiVariables, signal?: AbortSignal) {
  if (!projectRef) {
    throw Error('projectRef is required')
  }

  const { data, error } = await get('/platform/projects/{ref}/settings', {
    params: {
      path: { ref: projectRef },
    },
    signal,
  })
  if (error) throw error
  return data
}