我应该使用哪种类型在jsdoc中记录ES6模块参数?

时间:2019-02-09 18:07:15

标签: ecmascript-6 jsdoc es6-modules jsdoc3

假设我这样导入ES6 module

import * as moduleVar1 from "./variant/One.js";
import * as moduleVar2 from "./variant/Two.js";
import * as moduleVar3 from "./variant/Three.js";

现在,例如使用常规的switch-case语句或类似方法以编程方式选择已加载的模块之一。所选模块通过module = moduleVar1(或类似名称)保存在变量中。

最后,我想将模块传递给另一个函数:

continueFunction(module)

现在,如何在函数中记录参数类型(此处为continueFunction),以便它指定它接受ES6模块?

我的意思是,@param {Object}很合适,但这并不是很具体。

1 个答案:

答案 0 :(得分:0)

您将使用导出类型的标签。例如,如果所有模块都是Number,那么您将使用@param {Number}