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[]
  

  객체 매개변수의 중첩된 매개변수 데이터