붉은거위 노트 (redgoose note)

jsdoc 객체타입 표현

Nest
Development
Category
Javascript
Hit
26
Star
0

screenshot-2024-05-11-15-18-27.webp

이런모습 좋다.
여태까지 jsdoc에서 특히 오브젝트 요소들의 타입을 어떻게 가이드해주는게 좋은지 좋은 방법을 찾지 못했었는데 우연히 다른 저장소 열어보다가 알게 되었다.

/**
 * 관리자 유저 추가
 * @param {string} [user.email] 이메일 주소
 * @param {string} [user.name] 이름
 * @param {string} [user.password] 패스워드
 * @return {Promise<void>}
 */
async function addUser(user)
{
  const { email, name, password } = user
  console.log(email, name, password)
}