TypedefData

Represents the parsed result of @typedef tags in JSDoc. Used to define custom types or complex object structures.

Signature

interface TypedefData { name: string; type: string; description: string; properties: PropertyData[] }

Parameters

• nameRequired · string
  

  Name of the type

• typeRequired · string
  

  Base type of the type (e.g., Object, Array, etc.)

• descriptionRequired · string
  

  Description of the type

• propertiesRequired · PropertyData[]
  

  Array of property information if the type is an object