How To Describe Destructured Object Arguments In Jsdoc
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}
Solution 1:
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
*/constfoo = ({ baz, qux }) => baz + qux;
Post a Comment for "How To Describe Destructured Object Arguments In Jsdoc"