support function type documentation

[souporserious]

Adds support for function type documentation in getTypeDocumentation by parsing properties that are FunctionType. This can be the case for several reasons, but came up when documenting child functions in React:

import * as React from 'react';

function getExportedTypes() {
  return [
    { 
      /** The name of the component. */ 
      name: 'Button',

      /** The description of the component. */
      description: 'A button component' 
    }
  ]
}

type ExportedTypesProps = {
  /** Controls how types are rendered. */
  children?: (
    exportedTypes: ReturnType<typeof getExportedTypes>
  ) => React.ReactNode
}

function ExportedTypes({ children }: ExportedTypesProps) {}

Is now parsed as:

{
  "name": "ExportedTypes",
  "parameters": [
    {
      "properties": [
        {
          "description": "Controls how types are rendered.",
          "name": "children",
          "parameters": [
            {
              "name": "exportedTypes",
              "type": "{ name: string; description: string; }[]",
            },
          ],
          "required": false,
          "returnType": "React.ReactNode",
          "type": "(exportedTypes: ReturnType<typeof getExportedTypes>) => React.ReactNode",
        },
      ],
      "required": true,
      "type": "ExportedTypesProps",
   }
 ]
}

This will still include unrelated fields like defaultValues, required etc since this is utilizing the same utility to unwrap normal function arguments. An additional function type arguments utility can be handled in a follow-up.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
tsxmod	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jun 17, 2024 6:56pm

[changeset-bot]

🦋 Changeset detected

Latest commit: 6f01c3e

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages

Name	Type
@tsxmod/utils	Minor
tsxmod	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR