dateDiffInYears( )
计算两个日期之间的年差。
调用 dateDiffInYears( ) 帮助程序函数时,会将开始日期和结束日期作为参数传递。该函数返回负数或正数值,指示两个日期之间的差异(以年为单位)。
注:
为日期帮助程序函数提供参数的顺序很重要;生成的返回值取决于作为第一个或第二个参数传入的日期。
此函数仅用于比较日期类型的变量,这些变量不包含时间元素,也不包含部分日期。使用日期/时间类型参数时,函数仅考虑日期部分并忽略时间元素。
提示:
- 可以使用 timeDiffInMinutes( ) 帮助程序函数比较两个日期和时间项。
- 如果日期问题包含部分日期元素,则使用 getDatesCompareResult( ) 帮助函数。
语法
dateDiffInYears(toDate, fromDate)
参数
注:
您必须比较格式相同的日期。参数 | 必填/可选 | 说明 |
---|---|---|
toDate |
必需 | 结束日期值。 |
fromDate |
必需 | 开始日期值。 |
返回值
表示传入日期之间以年为单位的差值的数字。此数字可以为正,也可以为负。
- 如果返回的数字值是负值或零值,则意味着
toDate
早于或与fromDate
相同。 - 如果函数返回正值,则
toDate
在fromDate
之后。
示例
示例 3-5 两个日期项之间的差异
// Given 2 form questions of type Date (with no time elements) are defined in the rule as variables:
return dateDiffInYears(dateItem1, dateItem2);
示例 3-6 两个硬编码日期之间的差异
var toDate = new Date("March 1, 2020");
var fromDate = new Date("March 1, 2000");
return dateDiffInYears(toDate, fromDate);
// Returns value: 20
父主题: 日期和时间函数