generateLabelParam() — supabase Function Reference

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

Function typescript DocumentationSystem ReferenceGen calls 2 called by 1

Entity Profile

DocumentationSystem→ ReferenceGen→ generateLabelParam() — supabase Function Reference

Dependency Diagram

graph TD
  6f8bb888_f260_e3d0_0f56_7e5048c6953c["generateLabelParam()"]
  be6aa80b_289e_feca_40ab_a7604504fab7["recurseThroughParams()"]
  be6aa80b_289e_feca_40ab_a7604504fab7 -->|calls| 6f8bb888_f260_e3d0_0f56_7e5048c6953c
  851a5c10_0883_4cf2_68ca_71dbf78078ec["tsDocCommentToMdComment()"]
  6f8bb888_f260_e3d0_0f56_7e5048c6953c -->|calls| 851a5c10_0883_4cf2_68ca_71dbf78078ec
  4d714e29_17f3_63d7_6bcd_26610b82f16c["extractParamTypeAsString()"]
  6f8bb888_f260_e3d0_0f56_7e5048c6953c -->|calls| 4d714e29_17f3_63d7_6bcd_26610b82f16c
  style 6f8bb888_f260_e3d0_0f56_7e5048c6953c fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

apps/docs/lib/refGenerator/helpers.ts lines 118–150

function generateLabelParam(param: any) {
  let labelParams: any = {}
  if (param.type?.type === 'intrinsic' && param.type?.name === 'unknown') {
    labelParams = {
      name: param.name ?? param.value,
      isOptional: Boolean(param.flags?.isOptional) || 'defaultValue' in param,
      type: 'any',
      description: param.comment ? tsDocCommentToMdComment(param.comment) : null,
    }
  } else if (param.type?.declaration?.signatures) {
    labelParams = {
      name: param.name ?? param.value,
      isOptional: Boolean(param.flags?.isOptional) || 'defaultValue' in param,
      type: 'function',
      description: param.comment ? tsDocCommentToMdComment(param.comment) : null,
    }
  } else if (param.type?.type === 'literal') {
    labelParams = {
      name: param.name ?? param.value,
      isOptional: Boolean(param.flags?.isOptional) || 'defaultValue' in param,
      type: typeof param.type.value === 'string' ? `"${param.type.value}"` : `${param.type.value}`,
      description: param.comment ? tsDocCommentToMdComment(param.comment) : null,
    }
  } else {
    labelParams = {
      name: param.name ?? extractParamTypeAsString(param),
      isOptional: Boolean(param.flags?.isOptional) || 'defaultValue' in param,
      type: extractParamTypeAsString(param),
      description: param.comment ? tsDocCommentToMdComment(param.comment) : null,
    }
  }
  return labelParams
}