4

VSCode lets me autocomplete a JSDoc when I start typing /** which is nice, and it even fills in some params.

But a) it defaults all the params to * and b) it doesn't help when I'm destructuring an object in a function definition.

e.g. if I had

const FloopThePig = ({pigCount, floopStrength}) => { ...

Then autocompleting the JSDoc gives me:

/**
 * @param {*} param0 
 */
const FloopThePig = ({pigCount, floopStrength}) => { ...

When really I'd like to customise it to something like

/**
 * @param {object} props
 * @param {unknown} props.pigCount 
 * @param {unknown} props.floopStrength
 */
const FloopThePig = ({pigCount, floopStrength}) =>

I'm not set on it having to be 'unknown' but something other than *, and documenting the destructured params is what I've been trying to find.

Is this possible, and if so how?

AncientSwordRage
  • 7,086
  • 19
  • 90
  • 173
  • 1
    It is a requested feature that has not yet been implemented. [GitHub issue](https://github.com/microsoft/TypeScript/issues/27942). – Matt Schlosser Apr 20 '22 at 04:36

0 Answers0