JSDoc：定义具有字符串类型的参数的允许值

Question

我正在使用JSDoc，我想将信息添加到我的文档中，参数应该具有哪个值。

在此示例中，您可以看到该参数operator具有字符串类型。但是此外，参数只能存在open或close为有效值

/**
 * Description
 * @param {string='open','close'}  operator
 */

什么是正确的语法来添加这些信息？

Answer 1

使用类型联合|：

/**
 * Description
 * @param {('open'|'close')}  operator
 */