TJ-JSTOOLS【时间操作 —— calculateStartEndTime】
功能描述： 计算指定时间维度的开始和结束时间
1. 函数引入
js
import { calculateStartEndTime } from 'tj-jstools'
1
2. 函数声明
ts
declare const calculateStartEndTime: (
baseDate: dayjs.Dayjs,
dimension: TimeDimension
) => { start: dayjs.Dayjs; end: dayjs.Dayjs };
1
2
3
4
2
3
4
3. 使用示例
3.1 计算当天的开始和结束时间
ts
const { start, end } = calculateStartEndTime(dayjs(), 'day');
console.log(start.format('YYYY-MM-DD HH:mm:ss')); // 输出当天的开始时间
console.log(end.format('YYYY-MM-DD HH:mm:ss')); // 输出当天的结束时间
1
2
3
2
3
3.2 计算本周的开始和结束时间
ts
const { start, end } = calculateStartEndTime(dayjs(), 'week');
console.log(start.format('YYYY-MM-DD')); // 输出本周的第一天
console.log(end.format('YYYY-MM-DD')); // 输出本周的最后一天
1
2
3
2
3
3.3 计算本月的开始和结束时间
ts
const { start, end } = calculateStartEndTime(dayjs(), 'month');
console.log(start.format('YYYY-MM-DD')); // 输出本月的第一天
console.log(end.format('YYYY-MM-DD')); // 输出本月的最后一天
1
2
3
2
3
4. 参数说明
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| baseDate | dayjs.Dayjs | 是 | 基准日期 |
| dimension | TimeDimension | 是 | 时间维度，支持：'day'、'week'、'month'、'quarter'、'year' |
5. 返回值
返回一个包含start和end属性的对象，分别表示指定时间维度的开始和结束时间。
6. 注意事项
baseDate参数必须是一个dayjs.Dayjs对象- 返回的时间对象可以继续使用
dayjs的方法进行格式化或其他操作 - 计算周的开始和结束时间基于ISO周标准（周一开始）
TIP
建议使用dayjs的format方法将返回的Dayjs对象转换为需要的字符串格式