JSDoc: назначить тип для встроенной переменной

Question

Могу ли я назначить тип переменной, которая получает object результат из сторонней библиотеки?

const result = thirdPartyLib.doSomething();

Теперь у меня может быть класс ES6

class MyClass {
  ...
}

И я хочу аннотировать мои result типа MyClass.

Возможно ли это с помощью JSDoc?

Answer 1

Тег JSDoc @type {…} может быть применен к локальной переменной для объявления ее типа.

/** @type {MyClass} */
const result = thirdPartyLib.doSomething();

Однако вместо добавления этого объявления везде, где вы вызываете функцию, вы можете использовать тег @external для добавления типов JSDoc в thirdPartyLib.doSomething(), что позволяет правильно выводить типы локальных переменных.

/**
 * @external thirdPartyLib
 */
/**
 * @function external:thirdPartyLib.doSomething
 * @returns {MyClass}
 */

const result = thirdPartyLib.doSomething();