ParameterData

Represents the parsed result of @param tags in JSDoc.

Signature

interface ParameterData { name: string; type: string; description: string; required: boolean; defaultValue?: string; nested?: ParameterData[] }

Parameters

• nameRequired · string
  

  Parameter name

• typeRequired · string
  

  Parameter type

• descriptionRequired · string
  

  Parameter description

• requiredRequired · boolean
  

  Whether the parameter is required

• defaultValue · string
  

  Default value if the parameter is optional

• nested · ParameterData[]
  

  Nested parameter data for object parameters