Как документировать деструктурированные параметры в JSDoc?

Как документировать деструктурированные параметры в JSDoc?

Даже если вы деструктурировали ваши параметры, они все равно пришли из одного источника (объекта), который вам и нужен для документирования.

Я бы порекомендовал использовать @typedef для описания формы объекта и использовать его как тип при документировании вашей функции.

 /** * @typedef {object} Credentials * @property {number} userId * @property {string} token */ /** * @param {Credentials} credentials */ async function userInformation({ userId, token }) { // ... } 

Вот скринкаст из VS Code, показывающий, что он может интерпретировать этот блок документов. (Я уверен, что другие IDE могут сделать то же самое)

введите описание изображения здесь

Понравилась статья? Поделиться с друзьями:
JavaScript & TypeScript
Adblock
detector