Skip to content

@pmun/utils / diff

Function: diff()

ts
function diff(
   date1, 
   date2, 
   unit): number;

计算两个日期之间的差异

Parameters

date1

DateLike

第一个日期

date2

DateLike

第二个日期

unit

计量单位,默认为 'day',可以是 'year', 'month', 'week', 'day', 'hour', 'minute', 'second', 'millisecond'

"millisecond" | "second" | "minute" | "hour" | "day" | "month" | "year" | "date" | "milliseconds" | "seconds" | "minutes" | "hours" | "days" | "months" | "years" | "dates" | "d" | "D" | "M" | "y" | "h" | "m" | "s" | "ms" | "quarter" | "quarters" | "Q" | "week" | "weeks" | "w"

Returns

number

两个日期之间的差值,正数表示 date1 晚于 date2,负数表示 date1 早于 date2

Example

ts
diff('2023-05-15', '2023-05-10') // 5(相差5天)
diff('2023-05-15', '2023-06-15', 'month') // -1(相差1个月,且第一个日期早于第二个)
diff('2023-05-15 08:00', '2023-05-15 06:00', 'hour') // 2(相差2小时)