如何使用 JSDoc 记录符号索引签名以符合打字稿？

Question

I am using plain Javascript for creating a class and documenting it using JSDoc and I am using typescript for type checking.

But I cannot figure out how to write a JSDoc properly so it would recognise the field access using a Symbol.

const secret = Symbol('secret');
class MyClass {
  constructor() {
    /** @type {Map<string,number>} */
    this[secret] = new Map();
  }
  method() {
    const map = this[secret];
    // Should give an error in the following line since 1 is not a string
    map.set(1, '2');
  }
}

The result I get from VSCode is the following (as you can see map has type any ):

In TypeScript is pretty easy to make it work, just declare it like any other class property.

const secret = Symbol('secret');
class MyClass {
  [secret]: Map<string, number>; // Declared here
  constructor() {
    this[secret] = new Map();
  }
  method() {
    const map = this[secret];
    map.set(1, '2');
  }
}

The VSCode (typescript) error i get:

Answer 1

You've secret signature as Map<string, number>; so secret MUST have first param as string and second param as number .

Correct example would be

map.set('2',1)