正确的JSDoc typedef函数声明,带有javascript中的可选参数

时间:2018-05-28 07:30:15

标签: javascript webstorm typedef jsdoc

给出以下typedef

/***
 * @typedef {object} Queue
 * @property {function(string):string[]} listQueueNames Gets an optionally 
   filtered list of QueueNames. 
 */

将listQueueName的Argument标记为可选参数的正确方法是什么?

1 个答案:

答案 0 :(得分:2)

使用Closure Compiler语法应该可以在这里工作:

/***
 * @typedef {object} Queue
 * @property {function(string=):string[]} listQueueNames Gets an optionally 
   filtered list of QueueNames. 
 */