ParameterData

JSDoc에서 @param 태그를 파싱한 결과를 나타내요.

시그니처

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

매개변수

• nameRequired · string
  

  매개변수 이름

• typeRequired · string
  

  매개변수 타입

• descriptionRequired · string
  

  매개변수 설명

• requiredRequired · boolean
  

  매개변수가 필수인지 여부

• defaultValue · string
  

  매개변수가 선택적인 경우의 기본값

• nested · ParameterData[]
  

  객체 매개변수에 대한 중첩된 매개변수 데이터