generateParameters() — supabase Function Reference

Architecture documentation for the generateParameters() function in helpers.ts from the supabase codebase.

Function typescript DocumentationSystem ReferenceGen calls 1

Entity Profile

DocumentationSystem→ ReferenceGen→ generateParameters() — supabase Function Reference

Dependency Diagram

graph TD
  a497a5f1_fc0b_a0c7_1eba_9f92c95550b7["generateParameters()"]
  be6aa80b_289e_feca_40ab_a7604504fab7["recurseThroughParams()"]
  a497a5f1_fc0b_a0c7_1eba_9f92c95550b7 -->|calls| be6aa80b_289e_feca_40ab_a7604504fab7
  style a497a5f1_fc0b_a0c7_1eba_9f92c95550b7 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

apps/docs/lib/refGenerator/helpers.ts lines 26–43

export function generateParameters(tsDefinition: any) {
  let functionDeclaration: any = null
  if (tsDefinition.kindString == 'Method') {
    functionDeclaration = tsDefinition
  } else if (tsDefinition.kindString == 'Constructor') {
    functionDeclaration = tsDefinition
  } else functionDeclaration = tsDefinition?.type?.declaration
  if (!functionDeclaration || !functionDeclaration.signatures) return ''

  // Functions can have multiple signatures - select the last one since that
  // tends to be closer to primitive types (citation needed).
  const paramDefinitions: TsDoc.TypeDefinition[] = functionDeclaration.signatures.at(-1)?.parameters
  if (!paramDefinitions) return ''

  // const paramsComments: TsDoc.CommentTag = tsDefinition.comment?.tags?.filter(x => x.tag == 'param')
  let parameters = paramDefinitions.map((x) => recurseThroughParams(x)) // old join // .join(`\n`)
  return parameters
}