Skip to content
本章目录

【时间操作 —— getNextHoliday】

功能描述: 获取下一个节假日的日期和名称

1. 函数引入

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

2. 函数声明

ts
declare const getNextHoliday: (date?: string) => { date: string; name: string } | null;
1

3. 使用示例

3.1 获取下一个节假日

ts
const nextHoliday = getNextHoliday();
console.log(nextHoliday);
// 输出: { date: "2023-10-01", name: "国庆节" }
1
2
3

3.2 从指定日期开始获取下一个节假日

ts
const nextHoliday = getNextHoliday('2023-01-01');
console.log(nextHoliday);
// 输出: { date: "2023-01-22", name: "春节" }
1
2
3

3.3 处理无节假日的情况

ts
const nextHoliday = getNextHoliday('2023-12-31');
console.log(nextHoliday);
// 输出: null
1
2
3

4. 参数说明

参数名类型必填说明
datestring起始日期,格式为YYYY-MM-DD,默认为当前日期

5. 返回值

返回一个对象{ date: string; name: string } | null,包含下一个节假日的日期和名称,如果指定日期之后没有节假日则返回null

6. 注意事项

  1. 输入的日期字符串必须符合ISO 8601格式
  2. 节假日数据基于中国的法定节假日安排
  3. 如果输入的日期格式不正确,将返回null
  4. 支持跨年查询

TIP

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

Released under the MIT License.