Type Annotation (use JsDoc)

JsDoc

- 타입 객체

/**                   ↓ 아래에서 사용하는 타입 객체
* @typedef {object} Address
* @property {string} street
* @property {string} city
*/
→ typedef & property로 다른곳에서 사용될 타입 객체의 property를 정의 가능 

/**                   ↓ 아래에서 사용하는 타입 객체
* @typedef {object} User
* @property {string} name
* @property {string} email
                ↓ type에 type객체를 쓸 수 있고, 그에 대한 정의를 위에서 해줄 수 있다
* @property {Address} address
*/
→ 타입객체는 하나의 property의 타입으로도 쓰일 수 있음

/**                   ↓ 타입 객체에 대한 정의를 위에서 해줄 수 있다.
* @returns {Promise<User>}
*/
function fetchUsers = (res) = {
	res.name
}

• 이렇게 설정 후 사용하면, 해당 객체 안에 어떤 property들이 있는지 자동완성됨!

- param

* @param {타입} 파람명 설명 << 방식으로 jsdoc에 입력해서 사용

/** 
* @param {number} a 첫번째숫자
* @param {number} b 두번째숫자
*/

function add = (a:number, b:number) = {
	return a + b
}

• 타입 미리보기 및 설명 제공