可能な値が制限されたjsdocで文字列型を文書化する方法

1つの文字列パラメータを受け入れる関数があります。このパラメーターは、いくつかの定義可能な値のうちの1つのみを持つことができます。同じことを文書化する最良の方法は何ですか？shapeTypeは、列挙型、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;
};

問題の2番目の部分は、の可能な値が、提案したものとして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;
};

もちろん、これは専用の列挙型ほど再利用可能ではありませんが、多くの場合、ダミーの列挙型は1つの関数でのみ使用される場合はやり過ぎです。

参照：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を使用しています。

これがClosureCompilerがサポートする方法です。「@ enum」を使用して制限付きタイプを定義できます。実際に列挙型定義で値を定義する必要はありません。たとえば、次のような「整数」型を定義できます。

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

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

Intは通常、「number」（数値）に割り当てることができますが、「number」は、何らかの強制（キャスト）がないと「Int」に割り当てることができません。