JSDoc - 记录混合数组

时间:2016-03-25 17:21:16

标签: javascript arrays documentation jsdoc

在JsDoc中,如何记录接受多个对象类的数组,如下所示:

.ebextensions

如何编写类型,使var arr = [new Foo(), new Bar()]; Foo是数组中唯一接受的类?

1 个答案:

答案 0 :(得分:2)

如果第一个对象的类型应始终为Foo而第二个对象始终为Bar,那么我们将查看将被理解为元组对象的内容。在这种情况下,正确的JSDoc类型将是:

/** @type {[Foo, Bar]} */
const arr = [new Foo(), new Bar()];

而不是Array<Foo|Bar>,因为后者允许像[new Foo(), new Foo()]这样的东西,这可能是不受欢迎的。