名前
この名前は、アダプティブフォームのルールエディターでカスタム関数を識別するために使用されます。 次の構文を使用して、カスタム関数に名前を付けます。
@name [functionName] <Function Name>
@function [functionName] <Function Name>
@func [functionName] <Function Name>
。functionName
は関数の名前です。スペースは使用できません。<Function Name>
は、アダプティブフォームのルールエディター内の関数の表示名です。
関数名が関数自体の名前と同じ場合は、構文から[functionName]
を省略できます。
パラメーター
パラメーターは、カスタム関数で使用される引数のリストです。 関数は複数のパラメーターをサポートできます。カスタム関数のパラメーターを定義するには、次の構文を使用します。
-
@param {type} name <Parameter Description>
-
@argument
{type} name <Parameter Description>
-
@arg
{type}
name <Parameter Description>
。{type}
は、パラメータータイプを表します。 許可されているパラメータータイプは、以下のとおりです。- string:単一の文字列値を表します。
- number:単一の数値を表します。
- boolean:単一のブール値(true または false)を表します。
- string[]:文字列値の配列を表します。
- number[]:数値の配列を表します。
- boolean[]:ブール値の配列を表します。
- date:単一の日付値を表します。
- date[]:日付値の配列を表します。
- array:様々なタイプの値を含む汎用の配列を表します。
- object:値を直接渡す代わりに、カスタム関数に渡されるフォームオブジェクトを表します。
- scope: globals オブジェクトを表します。このオブジェクトには、フォームインスタンス、ターゲットフィールドインスタンス、カスタム関数内でフォームの変更を実行するためのメソッドなどの読み取り専用変数が含まれています。 これはJavaScript注釈の最後のパラメーターとして宣言され、アダプティブフォームのルールエディターには表示されません。 scope パラメーターは、フォームまたはコンポーネントのオブジェクトにアクセスして、フォームの処理に必要なルールまたはイベントをトリガーします。Globals オブジェクトの詳細と使用方法については、 ここをクリックしてください。
パラメータータイプでは大文字と小文字が区別されず、パラメーター名にはスペースを使用できません。
<Parameter Description>
には、パラメーターの目的に関する詳細が含まれます。複数の単語を含めることができます。
オプションパラメーター
デフォルトでは、すべてのパラメーターが必須です。 パラメーターをオプションとして定義するには、パラメータータイプの後に =
を追加するか、[]
でパラメーター名を囲みます。 JavaScript アノテーションでオプションとして定義されたパラメーターは、ルールエディターでオプションとして表示されます。
変数をオプションのパラメーターとして定義するには、次の構文のいずれかを使用します。
@param {type=} Input1
上記のコード行では、Input1
はオプションのパラメーターで、デフォルト値はありません。 デフォルト値を使用してオプションのパラメーターを宣言するには:@param {string=<value>} input1
デフォルト値を value
に設定したオプションのパラメーターとして input1
を指定します。
@param {type} [Input1]
上記のコード行では、Input1
はオプションのパラメーターで、デフォルト値はありません。 デフォルト値を使用してオプションのパラメーターを宣言するには:@param {array} [input1=<value>]
input1
は、デフォルト値が value
に設定された配列型のオプションのパラメーターです。
パラメータ タイプが中括弧 {} で囲まれ、パラメータ名が角括弧で囲まれていることを確認してください。
次のコードスニペットについて考えてみます。input2 はオプションのパラメーターとして定義されています。
/**
* optional parameter function
* @name OptionalParameterFunction
* @param {string} input1
* @param {string=} input2
* @return {string}
*/
function OptionalParameterFunction(input1, input2) {
let result = "Result: ";
result += input1;
if (input2 !== null) {
result += " " + input2;
}
return result;
}
ルールエディターで OptionalParameterFunction
カスタム関数を使用した例を次に示します。
必須パラメーターの値を指定せずにルールを保存できますが、ルールは実行されず、次のような警告メッセージが表示されます。
ユーザーがオプションパラメーターを空のままにすると、「未定義」の値がオプションパラメーターのカスタム関数に渡されます。
JSDocs でオプション パラメータを定義する方法の詳細については、 ここをクリックしてください。
戻り値のタイプ
戻り値のタイプは、カスタム関数が実行後に返す値のタイプを指定します。カスタム関数の戻り値のタイプを定義するには、次の構文を使用します。
-
@return {type}
-
@returns {type}
{type}
は、関数の戻り値のタイプを表します。許可されている戻り値のタイプは、以下のとおりです。- string:単一の文字列値を表します。
- number:単一の数値を表します。
- boolean:単一のブール値(true または false)を表します。
- string[]:文字列値の配列を表します。
- number[]:数値の配列を表します。
- boolean[]:ブール値の配列を表します。
- date:単一の日付値を表します。
- date[]:日付値の配列を表します。
- array:様々なタイプの値を含む汎用の配列を表します。
- object:値を直接表す代わりに、フォームオブジェクトを表します。
戻り値のタイプでは、大文字と小文字は区別されません。