JSDoc - how to document function's static variable

Question

How do I properly JSDoc the function below?

function foo() {
  foo.counter = 1 + (foo.counter || 0)
}

Currently TS type checking (in vscode, with checkJs=true) complains: Property 'counter' does not exist on type '() => void'

How to declare a Static Variable inside a function in Typescript? — palaѕн
– palaѕн, Commented Jul 2, 2020 at 4:36

customcommander · Accepted Answer · 2020-07-05 08:14:18Z

0

You can document static members with JSDoc. I would use a namepath for this and so an extra block:

function foo() {
}

/**
 * My static counter
 * @name foo.counter
 * @type {number}
 */
foo.counter = 0;

Now my IDE (VS Code) is able to see it as a property and pull out the documentation:

answered Jul 5, 2020 at 8:14

customcommander

19.3k6 gold badges70 silver badges96 bronze badges

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

1 Answer 1