JSDoc typedef methods in VS Code

Question

I have an issue when trying to document javascript methods,

I tried this:

I really don't think I should be setting a property for getMother() but rather a method.

Yet I don't know if it's even supported (I'm using VS Code).

So the given example might work, but it doesn't add parenthesis when autocompleting and just isn't clean because we are seeing it as a property.

I spent a few hours searching for a solution and failed. I hope someone knows the answer, feel free to ask for more details.

Jay Kariesch · Accepted Answer · 2020-12-19 00:37:10Z

1

You can try something like this:

// @ts-check

/*
 * @typedef {{
 * age: number,
 * getMother(arg1: string, arg2: string): HTMLCat
 * } & HTMLElement} HTMLCat
 */

/*
 * @type {HTMLCat}
 */
var cat;

cat.getMother('a', 'b').age

I'm not sure what AdditionalCat is doing exactly since it's just an object, which would likely correlate with the key/value index I added, so I left it out. But this syntax might be a bit easier to reason about.

You can find more examples here: https://medium.com/better-programming/type-checking-in-vscode-without-typescript-eba92161cd08

edited Dec 19, 2020 at 0:37

answered Dec 17, 2020 at 20:56

Jay Kariesch

1,4929 silver badges14 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

Wo997 Over a year ago

Great answer! I'm wondering why it was so hard to find a good example / tutorial. I hope that maybe someone else will find it usefull.

Wo997 Over a year ago

I found out that adding optional parameters is as simple as "name?". I was confused because I didn't know that there are two types of notation.

Collectives™ on Stack Overflow

JSDoc typedef methods in VS Code

1 Answer 1

2 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

2 Comments

Your Answer

Sign up or log in

Post as a guest

Related