JSDoc comments are ignored for destructured parameters

[ryansully]

According to jsdoc/jsdoc#987 (comment), JSDoc for destructured function parameters should be possible:

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

However, when invoking the function, while Intellisense appears to support properties inside the object param, there is no documentation for individual params inside the destructured object, and the property types are not honored (shown as any instead):

If I set parameter defaults, Intellisense will support those, but will still ignore the types specified in the doc comment (notice that the JSDoc comment is not consistent with the function definition):

And in both cases, the entire object param is highlighted, but individual params inside it are not.

Is there a different way to write the JSDoc comment, or does support for destructured parameters need to be supported by VS Code as well?

[mjbvz]

Thanks for the report. Support for obj.prop properties in jsdoc is being tracked on the TypeScript side by microsoft/TypeScript#11597

[ankitsny]

How about creating a @typedef
this works fine for me.

/**
 * @typedef {Object} GetUsersParams
 * @property {number} page_size          - Number of results to show in a page, optional?
 * @property {number} page_number        - Page number, optional?
 * @property {Object} match_params       - match query, optional?
 */
/**
 * @description getUsers function can be used to fetch users
 * @param {GetUsersParams} params - Provide appropriate props
 * @param {function} cb
 */
function getUsers(params, cb) {
    // do something
}

I tried this, but it doesn't work

* @param {...GetUsersParams} params