Copy JSDoc from type when destructing arguments.

[kitsonk]

Search Terms

jsdoc argument destructuring

Suggestion

When specifying an interface which has JSDoc trivia, it should flow into any arguments that are destructured from that.

Refs #11859

Use Cases

When getting intellisense on destructured arguments, it is useful to be able to get the JSDoc of the specified interface. Currently, because TypeScript does not provide support for naming destructured arguments, obtaining the trivia seems like a more logical way anyways.

Examples

An example:

interface Options {
    /**
     * A description of foo
     */
    foo: string;
}

/**
 * A description of bar
 */
function bar({ foo }: Options) {
    foo; // Trivia could be: "A description of foo""
}

Currently, you get no JSDoc trivia.

Checklist

My suggestion meets these guidelines:

• This wouldn't be a breaking change in existing TypeScript / JavaScript code
• This wouldn't change the runtime behavior of existing JavaScript code
• This could be implemented without emitting different JS based on the types of the expressions
• This isn't a runtime feature (e.g. new expression-level syntax)