dateDiffInDays( )
2つの日付の間の日付差を日数で計算します。
dateDiffInDays( )ヘルパー・ファンクションは、開始日と終了日がパラメータとして渡された状態で起動されます。この関数は、2つの日付間の差異を示すマイナスまたはプラスの数値(日数)を返します。
ノート:
日付ヘルパー関数にパラメータを指定する順序は重要です。結果の戻り値は、最初のパラメータまたは2番目のパラメータとして渡す日付によって異なります。
この関数は、時間要素を含んでおらず日付の一部を含まない日付型の変数を比較する場合にのみ使用されます。日付/時間タイプ・パラメータを使用する場合、関数では日付部分のみが考慮され、時間要素は無視されます。
ヒント:
- timeDiffInMinutes( )ヘルパー関数を使用して、2つの日付と時間の項目を比較できます。
- 日付の質問に部分的な日付要素が含まれている場合は、getDatesCompareResult( )ヘルパー関数を使用します。
構文
dateDiffInDays(toDate, fromDate)
パラメータ
パラメータ | 必須/オプション | 説明 |
---|---|---|
toDate |
必須 | 終了日付の値。 |
fromDate |
必須 | 開始日の値。 |
戻り値
渡された日付間の差異を表す数値(日数)。この数値は、ポジティブでもネガティブでもかまいません。
- 返される数値が負またはゼロの値の場合、
toDate
がfromDate
の前または同じであることを意味します。 - ファンクションが正の値を返す場合、
toDate
はfromDate
の後です。
例)
例3-7 2つの日付アイテム間の差異
// Given 2 form questions of type DateTime are defined in the rule as variables:
return dateDiffInDays(datetem1, dateItem2);
例3-8ハードコードされた2つの日付の差異
var toDate = new Date("March 1, 2020");
var fromDate = new Date("March 1, 2019");
return dateDiffInDays(toDate, fromDate);
// Returns value: 366 (leap year!)
親トピック: 日時関数