Intellisense for object properties defined in multi-line JSDoc comments

[abgivant]

Currently it doesn't look like the TypeScript parser recognizes properties for an object parameter if they are defined with separate @param declarations. Would it be possible to add support for this?

Thanks!

[Jessidhia]

A workaround is to write:

/**
 * @param {{strProp: string, numProp: number}} obj - An object parameter with string and number properties
 */

but that doesn't allow for documenting the specific subkeys.

[abgivant]

@Kovensky Yeah, that does work, but the individual property documentation is the main reason I prefer the multi-line documenting.

[abgivant]

Sorry, didn't mean to close/reopen this...

[ryansully]

Would a solution to this also support destructured parameters as well?
Example: jsdoc/jsdoc#987 (comment)

[abgivant]

I haven't really used that pattern, but I would think it would. That seems to be an extension of the same underlying issue of being unable to document properties of object parameters.

[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 

[abgivant]

That's actually what I've been doing as a workaround, but it doesn't allow for documenting optional/default values.

You also don't get the text descriptions in intellisense. I wouldn't say that's necessary, but it'd be nice.