functionDetails() — supabase Function Reference

Architecture documentation for the functionDetails() function in route.ts from the supabase codebase.

Function typescript DocumentationSystem ReferenceGen calls 4 called by 1

Entity Profile

DocumentationSystem→ ReferenceGen→ functionDetails() — supabase Function Reference

Dependency Diagram

graph TD
  5df2c2c3_5161_a344_0c8e_a4d8e5d5d38e["functionDetails()"]
  a8b2ed85_9c96_f71a_d0f5_d7ba1cc4835c["sectionDetails()"]
  a8b2ed85_9c96_f71a_d0f5_d7ba1cc4835c -->|calls| 5df2c2c3_5161_a344_0c8e_a4d8e5d5d38e
  1bf57245_e9e4_508a_583c_f279cecc5990["getFunctionsList()"]
  5df2c2c3_5161_a344_0c8e_a4d8e5d5d38e -->|calls| 1bf57245_e9e4_508a_583c_f279cecc5990
  f6fdb326_7578_ab30_cfb3_855e5c138e6d["getTypeSpec()"]
  5df2c2c3_5161_a344_0c8e_a4d8e5d5d38e -->|calls| f6fdb326_7578_ab30_cfb3_855e5c138e6d
  17ca05b5_60ae_a264_14fb_b128dde6fc86["parametersToHtml()"]
  5df2c2c3_5161_a344_0c8e_a4d8e5d5d38e -->|calls| 17ca05b5_60ae_a264_14fb_b128dde6fc86
  e2411768_86c0_d660_902b_4725903ef9ad["examplesToHtml()"]
  5df2c2c3_5161_a344_0c8e_a4d8e5d5d38e -->|calls| e2411768_86c0_d660_902b_4725903ef9ad
  style 5df2c2c3_5161_a344_0c8e_a4d8e5d5d38e fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

apps/docs/app/api/crawlers/route.ts lines 128–157

async function functionDetails(
  lib: string,
  version: string | null,
  section: AbbrevApiReferenceSection
) {
  const libraryMeta = REFERENCES[lib]

  const fns = await getFunctionsList(lib, version ?? libraryMeta.versions[0])
  const fn = fns!.find((fn) => fn.id === section.id)
  if (!fn) return ''

  let types: MethodTypes | VariableTypes | undefined
  if (libraryMeta.typeSpec && '$ref' in fn) {
    types = await getTypeSpec(fn['$ref'] as string)
  }

  const fullDescription = [
    types?.comment?.shortText,
    'description' in fn && (fn.description as string),
    'notes' in fn && (fn.notes as string),
  ]
    .filter((x) => typeof x === 'string')
    .map(mdxToHtml)
    .join('')

  const parameters = parametersToHtml(fn, types)
  const examples = examplesToHtml(fn)

  return fullDescription + parameters + examples
}