Parámetro de función de documento desestructurado en JSDoc

Anteriormente, siempre he documentado los parámetros de mis objetos de la siguiente manera:

/**
 * 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
}

Pero no estoy seguro de cuál es el mejor enfoque con el parámetro de función descestructurado. ¿Simplemente ignoro el objeto, lo defino de alguna manera o cuál es la mejor manera de documentarlo?

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

Siento que mi enfoque anterior no hace que sea obvio que la función espera un objectparámetro diferente y no dos.

Otra forma en la que podría pensar sería usar @typedef, pero eso podría terminar siendo un gran desastre (especialmente en un archivo más grande con muchos métodos).

/**
 * @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
}

Así es como está previsto, como se describe en la documentación .

/**
 * 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
}

Entonces, su primer ejemplo es bastante correcto.

Otro ejemplo con un anidamiento más profundo:

/**
 * 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;

Yo personalmente uso este:

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

Simplemente crea el objeto allí mismo.

También aprovecho mecanografiado , y los anunciara obtional bcomo b?o b: number | undefinedcomo jsdoc también permite a los sindicatos

Consulte "Documentación de las propiedades de un parámetro" de 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) {
    // ...
};

(La verificación de tipo del compilador de cierre de Google , que se basó en JSDoc pero se desvió de él, también permite @param {{x:number,y:number}} point A "point-shaped" object.)