Skip to content
本章目录

【时间操作 —— getTimeDifference】

功能描述: 计算两个日期之间的时间差

1. 函数引入

js
import { getTimeDifference } from 'tj-jstools'
1

2. 函数声明

ts
declare const getTimeDifference: (startDate: string, endDate: string, unit?: string) => number;
1

3. 使用示例

3.1 计算两个日期之间的天数差

ts
const diff = getTimeDifference('2023-01-01', '2023-01-31', 'day');
console.log(diff); // 输出: 30
1
2

3.2 计算两个日期之间的小时差

ts
const diff = getTimeDifference('2023-01-01 08:00', '2023-01-01 18:00', 'hour');
console.log(diff); // 输出: 10
1
2

3.3 计算两个日期之间的分钟差

ts
const diff = getTimeDifference('2023-01-01 08:00', '2023-01-01 08:30', 'minute');
console.log(diff); // 输出: 30
1
2

4. 参数说明

参数名类型必填说明
startDatestring开始日期,格式为YYYY-MM-DDYYYY-MM-DD HH:mm
endDatestring结束日期,格式为YYYY-MM-DDYYYY-MM-DD HH:mm
unitstring时间单位,可选值为'day''hour''minute',默认为'day'

5. 返回值

返回一个number,表示两个日期之间的时间差,单位为指定的unit

6. 注意事项

  1. 输入的日期字符串必须符合ISO 8601格式
  2. 如果输入的日期格式不正确,将返回NaN
  3. 开始日期必须早于或等于结束日期,否则将返回负数
  4. 支持跨年日期计算

TIP

可以使用dayjs库对输入的日期进行格式化后再传入该函数

Released under the MIT License.