6

在 JavaScript 中,使用本质上是参数列表的数组是很常见的:一个小的固定长度,以及每个位置的已知类型。对于 ECMAScript 6 尤其如此,它引入了诸如rest 运算符、 spread 运算符迭代器协议之类的特性。

我想记录一个返回迭代器对象的函数,用于迭代键/值对。理想情况下,我想具体说明它的类型。是否可以使用(任何)JSDoc 做到这一点?这是我最近的尝试,但我不知道它是否有效:

/**
 * @returns { { next: function(): {done: boolean, value: [string, *]} } }
 */

jsdoc-to-markdown抱怨语法,但这可能是在他们的最后,而不是 JSDoc 3。如果是这样,我稍后会向他们发送错误报告。

编辑:这是一个可能返回的示例对象:

{
    next: function () {
        return {
            done: false,
            value: ['answer', 42]
        };
    }
}
4

0 回答 0