Documentare il parametro della funzione destrutturata in JSDoc

In precedenza ho sempre documentato i parametri dei miei oggetti come segue:

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

Ma non sono sicuro di quale sia l'approccio migliore con il parametro della funzione destrutturato. Ignoro l'oggetto, lo definisco in qualche modo o qual è il modo migliore per 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
}

Mi sembra che il mio approccio sopra non renda ovvio che la funzione si aspetta un objectparametro diverso e non due.

Un altro modo a cui potrei pensare sarebbe quello di usare @typedef, ma potrebbe finire per essere un enorme pasticcio (specialmente in un file più grande con molti metodi)?

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

Ecco come è inteso, come descritto nella documentazione .

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

Quindi, il tuo primo esempio è praticamente corretto.

Un altro esempio con una nidificazione più profonda:

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

Io personalmente uso questo:

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

Basta creare l'oggetto proprio lì.

Approfitto anche di TypeScript e dichiarerei facoltativo bcome b?o b: number | undefinedpoiché JSDoc consente anche le unioni

Vedere "Documentazione delle proprietà di un parametro" di 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) {
    // ...
};

(Il controllo del tipo del compilatore di Google Closure , basato su JSDoc ma deviato da JSDoc, consente anche @param {{x:number,y:number}} point A "point-shaped" object.)