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();