Параметр функції деструктурованої документа в JSDoc

Раніше я завжди документував свої параметри об’єкта наступним чином:

/**
 * Description of the function
 *
 * @param {Object} config - The configuration
 * @param {String} config.foo
 * @param {Boolean} [config.bar] - Optional value
 * @return {String}
 */
function doSomething (config = {}) {
  const { foo, bar } = config;
  console.log(foo, bar);
  // do something
}

Але я не впевнений, що найкращий підхід до деструктурованого параметра функції. Чи просто я ігнорую об'єкт, якимось чином його визначаю або який найкращий спосіб його документувати?

/**
 * Description of the function
 *
 * @param {String} foo
 * @param {Boolean} [bar] - Optional value
 * @return {String}
 */
function doSomething ({ foo, bar } = {}) {
  console.log(foo, bar);
  // do something
}

Я відчуваю, що мій підхід вище не дає зрозуміти, що функція очікує, objectа не два різні параметри.

Я міг би подумати про інший спосіб @typedef, але це може закінчитися величезним хаосом (особливо у великому файлі з багатьма методами)?

/**
 * @typedef {Object} doSomethingConfiguration
 * @property {String} foo
 * @property {Boolean} [bar] - Optional value
 */

/**
 * Description of the function
 *
 * @param {doSomethingConfiguration}
 * @return {String}
 */
function doSomething ({ foo, bar } = {}) {
  console.log(foo, bar);
  // do something
}

Ось як це задумано, як описано в документації .

/**
 * My cool function.
 *
 * @param {Object} obj - An object.
 * @param {string} obj.prop1 - Property 1.
 * @param {string} obj.prop2 - Property 2.
 */
var fn = function ({prop1, prop2}) {
  // Do something with prop1 and prop2
}

Отже, ваш перший приклад є в значній мірі правильним.

Інший приклад з глибшим вкладанням:

/**
 * Nesting example.
 *
 * @param {object} param
 * @param {number} param.a - First value
 * @param {object} param.b - Wrapper
 * @param {number} param.b.c - Second value
 * @return {number} sum a and b
 */
letters = ({a, b: {c}}) => a + c;

Я особисто користуюся цим:

/**
* @param {{
  a: number
  b: number
}} param0
* @returns {number} The sum
*/
const func = ({ a, b }) => a + b;

Просто створіть об’єкт прямо там.

Я також скористатися машинопис , і оголосить obtional в bякості b?або в b: number | undefinedякості JSDoc також дозволяє профспілкам

Див. Розділ JSDoc "Документування властивостей параметра" :

/**
 * Assign the project to an employee.
 * @param {Object} employee - The employee who is responsible for the project.
 * @param {string} employee.name - The name of the employee.
 * @param {string} employee.department - The employee's department.
 */
Project.prototype.assign = function(employee) {
    // ...
};

( Перевірка типу компілятора Google Closure , яка базувалася на JSDoc, але була відхилена від неї, також дозволяє @param {{x:number,y:number}} point A "point-shaped" object.)