如何用有限的可能值在jsdoc中记录字符串类型

我有一个接受一个字符串参数的函数。此参数只能具有几个定义的可能值之一。记录相同内容的最佳方法是什么？应该将shapeType定义为enum还是TypeDef或其他？

Shape.prototype.create = function (shapeType) {
    // shapeType can be "rect", "circle" or "ellipse"...
    this.type = shapeType;
};

Shape.prototype.getType = function (shapeType) {
    // shapeType can be "rect", "circle" or "ellipse"...
    return this.type;
};

问题的第二部分是，在shapeType定义shapeType为您所建议的内容的文件中，未知的可能值。有几个开发人员提供的多个文件可能会增加的可能值shapeType。

PS：正在使用 jsdoc3

如何声明一个虚拟枚举：

/**
 * Enum string values.
 * @enum {string}
 */
Enumeration = {
    ONE: "The number one",
    TWO: "A second number"
};

/**
 * Sample.
 * @param {Enumeration} a one of the enumeration values.
 */
Bar.prototype.sample = function(a) {};


b = new Bar();

bar.sample(Enumeration.ONE)

但是，您至少需要为此向JSDOC声明枚举。但是代码很干净，您可以在WebStorm中自动完成。

多文件问题虽然不能用这种方法解决。

从2014年末开始，您可以在jsdoc3中编写：

/**
 * @param {('rect'|'circle'|'ellipse')} shapeType - The allowed type of the shape
 */
Shape.prototype.getType = function (shapeType) {
  return this.type;
};

当然，它不会像专用枚举那样可重用，但是在许多情况下，如果虚拟枚举仅由一个功能使用，那就太过分了。

另请参阅：https : //github.com/jsdoc3/jsdoc/issues/629#issue-31314808

关于什么：

/**
 * @typedef {"keyvalue" | "bar" | "timeseries" | "pie" | "table"} MetricFormat
 */

/**
 * @param format {MetricFormat}
 */
export function fetchMetric(format) {
    return fetch(`/matric}`, format);
}

我认为JSDoc中没有正式的方式来编写允许的值。

您当然可以编写类似提到的@param {String('up'|'down'|'left'|'right')}用户b12toaster的内容。

但是，通过引用APIDocjs的方法，这就是我用来编写受约束的值（也称为allowedValues）的方法。

/**
 * Set the arrow position of the tooltip
 * @param {String='up','down','left','right'} position pointer position
 */
setPosition(position='left'){
  // YOUR OWN CODE
}

哦，是的，我正在使用ES6。

这是Closure Compiler支持的方式：您可以使用“ @enum”来定义受限类型。您实际上不必在枚举定义中定义值。例如，我可以定义一个“整数”类型，例如：

/** @enum {number} */
var Int = {};

/** @return {Int} */
function toInt(val) {
  return /** @type {Int} */ (val|0);
}

通常可以将Int分配给“数字”（它是一个数字），但是在没有强制（强制转换）的情况下，不能将“数字”分配给“ Int”。