Skip to content

ReturnData

JSDoc의 @returns 태그 파싱 결과를 나타내요. 함수의 반환값 정보를 설명하는 데 사용돼요.

시그니처

typescript
interface ReturnData {
  type: string;
  name?: string;
  description: string;
  properties?: PropertyData[];
}

속성

  • typeRequired · string

    반환값의 타입

  • name · string

    반환값의 이름 (선택)

  • descriptionRequired · string

    반환값의 설명

  • properties · PropertyData[]

    반환값이 객체일 때의 속성 정보 배열

MIT 라이선스에 따라 배포됩니다.