在JSDoc中,如果您有一个特定类型的数组(例如字符串数组),我可以找到的最佳文档显示使用以下内容:
/**
* @param {Array.<string>} myStrings All my awesome strings
*/
function blah(myStrings){
//stuff here...
}
Run Code Online (Sandbox Code Playgroud)
你如何替换下面的问号指定一个对象数组?
/**
* @param {???????} myObjects All of my equally awesome objects
*/
function blah(myObjects){
//stuff here...
}
Run Code Online (Sandbox Code Playgroud) 简单的问题,我如何记录"混合型"?我知道我可以列出所有可能的类型,{null|undefined|String|Number|Object}并最终发现自己错过了一个并使其过于复杂.我尝试使用Mixed关键字,但它会在许多IDE中弹出错误,例如WebStorm.
鉴于此代码:
function asyncFoo() {
return new Promise(function (fulfill, reject) {
doAsyncStuff(function(err, data) {
if(err) reject(new Error(err));
else fulfill(new Bar(data));
});
});
}
Run Code Online (Sandbox Code Playgroud)
我如何记录asyncFoo将返回一个Promise,当满足时将产生一个实例Bar,并且当被拒绝时将产生一个实例Error?
/**
* @return << Here, what do I have to write? >>
*/
function asyncFoo() { ... }
Run Code Online (Sandbox Code Playgroud)