JsDoc annotations don't play well with arguments destructuring

[KtorZ]

Code

As stated in this comment (I am afraid this won't be seen since the issue is closed, hence the issue):

/**
 * @param {Object} args 
 * @param {string} args.prop1
 * @param {string} args.prop2
 */
function patate({ prop1, prop2 }) {

}

Expected behavior:

Type-checking this using --allowJs and --checkJs shouldn't result in an error but rather apply the right type-annotations to the both properties.

Actual behavior:
The compiler raises the following error:

error TS8024: JSDoc '@param' tag has name 'args', but there is no parameter with that name.

Might be fixed by #18832 that would allow us to do the matching positionally.

[mhegazy]

Duplicate of #7429

[typescript-bot]

Automatically closing this issue for housekeeping purposes. The issue labels indicate that it is unactionable at the moment or has already been addressed.

[KtorZ]

@mhegazy You mentioned earlier that this was a duplicate of #7429 and #7429 is now labeled "fixed". Nevertheless, the bug I described earlier is still present in 2.6.2 and the latest nightly (2.7.0-dev.20180112).

:/ Any idea ?

[mhegazy]

you are right, the fix in #7429 did not address this case as well.

[que-etc]

@KtorZ

There is a workaround which we are using in our project. I don't really know if it works for you, as the following approach can't be used with function declarations, but anyway:

/**
 * @type {function({prop1: string, prop2: string}): void}
 */
const patate = ({prop1, prop2}) => {
    // ...
}

/**
 * This definition works as well.
 * @type {(args: {prop1: string, prop2: string}) => void}
 */
const patate = ({prop1, prop2}) => {
    // ...
}

It's certainly not as legible as describing every property in it's own @param annotation, though you can move object's definition to its own @typedef.

And there is one major pitfall of which you should know. TypeScript currently has a bug (#22080) which allows to invoke former function without any arguments:

/**
 * @type {function({prop: string}): void}
 */
const func = ({prop}) => {
    // ...
};

// TypeScript should raise an error for the following
// line ('Expect 1 argument, but got 0'), but unfortunately it doesn't. 
func();

I hope it helps.

[KtorZ]

Thanks. For now I've been simply doing the destructuring in the function body and it works fine, though I'd rather cut off this extra line... Perhaps I can apply your solution in some cases :/

/**
 * @param {Object} args 
 * @param {string} args.prop1
 * @param {string} args.prop2
 */
function patate(args) {
  const { prop1, prop2 } = args;
}