parametersToHtml() — supabase Function Reference

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

Function typescript DocumentationSystem ReferenceGen called by 1

Entity Profile

DocumentationSystem→ ReferenceGen→ parametersToHtml() — supabase Function Reference

Dependency Diagram

graph TD
  17ca05b5_60ae_a264_14fb_b128dde6fc86["parametersToHtml()"]
  5df2c2c3_5161_a344_0c8e_a4d8e5d5d38e["functionDetails()"]
  5df2c2c3_5161_a344_0c8e_a4d8e5d5d38e -->|calls| 17ca05b5_60ae_a264_14fb_b128dde6fc86
  style 17ca05b5_60ae_a264_14fb_b128dde6fc86 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

apps/docs/app/api/crawlers/route.ts lines 179–220

function parametersToHtml(fn: any, types: MethodTypes | VariableTypes | undefined) {
  let result = '<h2 id="parameters">Parameters</h2>'

  if ('overwriteParams' in fn || 'params' in fn) {
    const params = fn.overwriteParams ?? fn.params
    if (params.length === 0) return ''

    result +=
      '<ul>' +
      params
        .map(
          (param) =>
            '<li>' +
            `<h3>${param.name}</h3>` +
            `<span>${param.isOptional ? '(Optional)' : '(Required)'}</span>` +
            `<p>${param.description}</p>` +
            '</li>'
        )
        .join('') +
      '</ul>'

    return result
  }

  if (!types || !('params' in types) || !types.params || types.params.length === 0) return ''

  result +=
    '<ul>' +
    types.params
      .map(
        (param) =>
          '<li>' +
          `<h3>${String(param.name)}</h3>` +
          `<span>${param.isOptional ? '(Optional)' : '(Required)'}</span>` +
          `<p>${param.comment?.shortText ?? ''}</p>` +
          '</li>'
      )
      .join('') +
    '</ul>'

  return result
}