JSDoc，将 POJO 视为 Class 的实例

Question

我有一个类和一个函数，该类的实例或类似的 POJO 对象作为参数。

我想用 JSDoc 注释这个函数。

class Test {
    constructor(a, b) {
        this.a = a;
        this.b = b;
    }
}

/**
 * @param {Test} test
 */
function handleTest(test) {
    console.log(test.a, test.b);
}

// Webstorm complains that argument is not of type Test
handleTest({
    a: 'this is a'
});

使用@param {Test} test几乎可以工作...但 WebStorm 抱怨 POJO 不能分配给类型 Test。

我可以做一些 JSDoc 技巧来明确Test 的实例和类似Test 的对象都可以吗？

Answer 1

使用type union:

/**
 * @param {Test|{a,b}} test
 */
function handleTest(test) {
  console.log(test.a, test.b);
}

类型的|{a,b} 部分表示单独的允许类型。您可以只使用{Test|{}}，但IDE 不知道a 和b 是预期属性。

这是速记版本；如果您计划在多个地方使用和记录 TestLike 对象，您还可以定义什么是“类测试”对象：

/**
 * @typedef {object} TestLike
 * @property {string} a - some property a
 * @property {string} b - some property b
 */

/**
 * @param {Test|TestLike} test
 */
handleTest(test) {
  // ...
}