GitHub |
您所在的位置：网站首页 › 农历订阅ics2021 › GitHub |
GitHub
|
中国节假日
本项目提供了一系列用于查询中国节假日、调休日、工作日、24节气、以及农历阳历互转的函数，此外还支持 iCal 文件订阅节假日，可供 Google Calendar、Apple Calendar、Microsoft Outlook 等客户端订阅。 每日会执行 Action 自动抓取数据，节假日变化时发送邮件提醒，信息会跟随国务院发布进行更新。 节假日：支持 2004年 至 2024年，包括 2020年 的春节延长 24节气：支持 1900年 至 2100年。 农历日：支持 1900年 至 2100年。 非 JS 语言如果你不使用 JS 或 TS 开发项目，本项目提供了中国节假日的 JSON 文件，通过链接 chinese-days.json 可以直接引用。 日历订阅在 Google Calendar、Apple Calendar、Microsoft Outlook 等客户端中，可以设置订阅地址：https://cdn.jsdelivr.net/npm/chinese-days/dist/holidays.ics 来获取日历订阅。 For English: https://cdn.jsdelivr.net/npm/chinese-days/dist/holidays.en.ics 订阅的日历包含近三年（2022-2024年）的节假日和调休日。 快速开始 推荐方式直接浏览器引入，更新较为及时 chineseDays.isHoliday('2024-01-01'); // 或者解构使用 const { isHoliday } = chineseDays;或者 import chineseDays from 'https://cdn.jsdelivr.net/npm/chinese-days/dist/index.es.js' chineseDays.isHoliday('2024-01-01'); 其他方式安装 npm i chinese-days使用 ESM 导入 import chineseDays from 'chinese-days'; console.log(chineseDays);在 Node 中使用 const { isWorkday, isHoliday } = require('chinese-days'); console.log(isWorkday('2020-01-01')); console.log(isHoliday('2020-01-01')); 节假日模块 isWorkday 检查某个日期是否为工作日 console.log(isWorkday('2023-01-01')); // false isHoliday 检查某个日期是否为节假日 console.log(isHoliday('2023-01-01')); // true isInLieu 检查某个日期是否为调休日（in lieu day）在中国的节假日安排中，调休日是为了连休假期或补班而调整的工作日或休息日。例如，当某个法定假日与周末相连时，可能会将某个周末调整为工作日，或者将某个工作日调整为休息日，以便连休更多天。 // 检查 2024-05-02 返回 `true` 则表示是一个调休日。 console.log(isInLieu('2024-05-02')); // true // 检查 2024-05-01 返回 `false` 则表示不是一个调休日。 console.log(isInLieu('2024-05-01')); // false getDayDetail 检查指定日期是否是工作日函数用于检查指定日期是否是工作日，并返回一个是否工作日的布尔值和日期的详情。 如果指定日期是工作日，则返回 true 和工作日名称，如果是被调休的工作日，返回 true 和节假日详情。 如果是节假日，则返回 false 和节假日详情。 // 示例用法 // 正常工作日 周五 console.log(getDayDetail('2024-02-02')); // { "date": "2024-02-02", "work":true,"name":"Friday"} // 节假日 周末 console.log(getDayDetail('2024-02-03')); // { "date": "2024-02-03", "work":false,"name":"Saturday"} // 调休需要上班 console.log(getDayDetail('2024-02-04')); // { "date": "2024-02-04", "work":true,"name":"Spring Festival,春节,3"} // 节假日 春节 console.log(getDayDetail('2024-02-17')); // { "date": "2024-02-17", "work":false,"name":"Spring Festival,春节,3"} getHolidaysInRange 获取指定日期范围内的所有节假日接收起始日期和结束日期，并可选地决定是否包括周末。如果包括周末，则函数会返回包括周末在内的所有节假日；否则，只返回工作日的节假日。 tip: 即使不包括周末，周末的节假日仍然会被返回 // 示例用法 const start = '2024-04-26'; const end = '2024-05-06'; // 获取从 2024-05-01 到 2024-05-10 的所有节假日，包括周末 const holidaysIncludingWeekends = getHolidaysInRange(start, end, true); console.log('Holidays including weekends:', holidaysIncludingWeekends.map(d => getDayDetail(d))); // 获取从 2024-05-01 到 2024-05-10 的节假日，不包括周末 const holidaysExcludingWeekends = getHolidaysInRange(start, end, false); console.log('Holidays excluding weekends:', holidaysExcludingWeekends.map(d => getDayDetail(d))); getWorkdaysInRange 取指定日期范围内的工作日列表接收起始日期和结束日期，并可选地决定是否包括周末。如果包括周末，则函数会返回包括周末在内的所有工作日；否则，只返回周一到周五的工作日。 // 示例用法 const start = '2024-04-26'; const end = '2024-05-06'; // 获取从 2024-05-01 到 2024-05-10 的所有工作日，包括周末 const workdaysIncludingWeekends = getWorkdaysInRange(start, end, true); console.log('Workdays including weekends:', workdaysIncludingWeekends); // 获取从 2024-05-01 到 2024-05-10 的工作日，不包括周末 const workdaysExcludingWeekends = getWorkdaysInRange(start, end, false); console.log('Workdays excluding weekends:', workdaysExcludingWeekends); findWorkday 查找工作日查找从今天开始 未来的第 {deltaDays} 个工作日。 // 查找从今天开始 未来的第 {deltaDays} 个工作日 // 如果 deltaDays 为 0，首先检查当前日期是否为工作日。如果是，则直接返回当前日期。 // 如果当前日期不是工作日，会查找下一个工作日。 const currentWorkday = findWorkday(0); console.log(currentWorkday); // 查找从今天开始未来的第一个工作日 const nextWorkday = findWorkday(1); console.log(nextWorkday); // 查找从今天开始之前的前一个工作日 const previousWorkday = findWorkday(-1); console.log(previousWorkday); // 可以传第二个参数 查找具体日期的上下工作日 // 查找从 2024-05-18 开始，未来的第二个工作日 const secondNextWorkday = findWorkday(2, '2024-05-18'); console.log(secondNextWorkday); 节气模块 获取 24 节气的日期中国的二十四节气是传统的农业历法，它们标志着一年中不同的时间段。每个节气通常有特定的（开始）日期，但这个日期并不代表整个节气的持续时间。事实上，每个节气大约持续15天。 以“小满”为例，它的日期通常在公历5月20日左右开始，但并不止于这一天，而是持续到下一个节气开始。具体来说，小满大约持续到6月5日（芒种）前后。因此，“小满”节气的时间段是从5月20日左右到6月5日左右。 获取范围内节气日期数组 import { getSolarTermsInRange } from "chinese-days"; // 不传，查询当天 console.log(getSolarTermsInRange()) // [{date: '2024-05-29', term: 'lesser_fullness_of_grain', name: '小满', index: 10}] // index: 代表处于当前节气的第几天，从 1 开始 // 不传end，查询指定日期 console.log(getSolarTermsInRange('2024-05-01')) // [{date: '2024-05-01', term: 'grain_rain', name: '谷雨', index: 13}] // 查询范围内的节气 console.log(getSolarTermsInRange('2024-05-01', '2024-05-06')) /** * => * [ * {"date":"2024-05-01","term":"grain_rain","name":"谷雨","index":13}, * {"date":"2024-05-02","term":"grain_rain","name":"谷雨","index":14}, * {"date":"2024-05-03","term":"grain_rain","name":"谷雨","index":15}, * {"date":"2024-05-04","term":"grain_rain","name":"谷雨","index":16}, * {"date":"2024-05-05","term":"the_beginning_of_summer","name":"立夏","index":1}, * {"date":"2024-05-06","term":"the_beginning_of_summer","name":"立夏","index":2} * ] **/ 如果你仅想获取节气开始日期数组 import { getSolarTerms } from "chinese-days"; /** 获取范围内 节气的开始日期数组 */ const solarTerms = getSolarTerms("2024-05-01", "2024-05-20"); solarTerms.forEach(({ date, term, name }) => { console.log(`${name}: ${date}, ${term}`); }); // 立夏: 2024-05-05, the_beginning_of_summer // 小满: 2024-05-20, lesser_fullness_of_grain // 没有节气 返回 [] getSolarTerms("2024-05-21", "2024-05-25"); // return [] /* 不传 end 参数， 获取某天 节气 */ getSolarTerms("2024-05-20"); // return: [{date: '2024-05-20', term: 'lesser_fullness_of_grain', name: '小满'}] 阳历农历互转特别说明，此库中： 2057-09-28 为：农历丁丑(牛)年八月三十； 2097-08-07 为：农历丁巳(蛇)年七月初一。 阳历转换农历 // 2097-8-7 console.log(getLunarDate('2097-08-07')); // 2057-9-28 console.log(getLunarDate('2057-09-28')); // { // date: "2057-09-28", // lunarYear: 2057, // lunarMon: 8, // lunarDay: 30, // isLeap: false, // lunarDayCN: "三十", // lunarMonCN: "八月", // lunarYearCN: "二零五七", // yearCyl: "丁丑", // monCyl: "己酉", // dayCyl: "戊子", // zodiac: "牛" // } // 非闰月 和 闰月例子 console.log(getLunarDate('2001-04-27')); console.log(getLunarDate('2001-05-27')); 根据阳历日期区间，批量获取农历日期 console.log(getLunarDatesInRange('2001-05-21', '2001-05-26')); 农历转换阳历当为阴历闰月的时候，会出现一个农历日期对应两个阳历日期的情况，所以返回对象形式。 console.log(getSolarDateFromLunar('2001-03-05')); // {date: '2001-03-29', leapMonthDate: undefined} console.log(getSolarDateFromLunar('2001-04-05')); // {date: '2001-04-27', leapMonthDate: '2001-05-27'} 贡献代码 Fork + Clone 项目到本地； 节假日: 修改 节假日定义； 农历定义: 修改 农历定义； 其他修改...； 提交PR。 致谢 农历数据来自于 Bigkoo/Android-PickerView 项目。 中国节假日数据生成参考了 Python 版本的 LKI/chinese-calendar 项目。 |
【本文地址】