If I have a JavaScript function taking an object as a parameter, I can describe expected properties of the object with JSDoc like this:
/**
* @param bar
* @param bar.baz {number}
* @param bar.qux {number}
*/
function foo(bar) {
return bar.baz + bar.qux;
}
How do I describe these properties if I define my function with ECMAScript 6 destructuring, not giving the real parameter object a name at all?
const foo = ({ baz, qux }) => baz + qux;
If a parameter is expected to have a specific property, you can document that property by providing an additional @param tag. For example, if an employee parameter is expected to have name and department properties, you can document it as follows: /** * Assign the project to a list of employees.
The @param tag provides the name, type, and description of a function parameter.
A parameter is a named variable passed into a function. Parameter variables are used to import arguments into functions. For example: function example(parameter) { console.
It turns out JSDoc does support destructing via making up a placeholder name. It is lacking in official documentation.
http://usejsdoc.org/tags-param.html#parameters-with-properties
/**
* @param {Object} param - this is object param
* @param {number} param.baz - this is property param
* @param {number} param.qux - this is property param
*/
const foo = ({ baz, qux }) => baz + qux;
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With