ChinaHoliday

ChinaHoliday is a lightweight library designed to help developers access official public holidays and adjusted working days in China, excluding weekends. The data is fetched from https://date.appworlds.cn/year/{year}, ensuring up-to-date and accurate information. This library offers direct access to JSON data via unpkg for front-end projects as well as an npm package for use in Node.js environments, through a straightforward API findChinaHolidayByYears.

Features

• Direct Access: Fetch the latest official public holidays and adjusted working days from an online data source.
• Multiple Access Methods: Access JSON data directly through unpkg in front-end projects or use the npm package in Node.js environments.
• Easy to Use: A simple API, findChinaHolidayByYears, to query holidays and adjusted days for specified years.
• Weekend-Free: Focus on official public holidays and adjusted days, without including weekend data.

Installation

You can use ChinaHoliday through two mainstream methods:

Via unpkg

Directly include the JSON data in your HTML file via a <script> tag:

<script src="https://unpkg.com/path_to_chinaholiday_json"></script>

Make sure to replace path_to_chinaholiday_json with the actual path to the JSON file.

Via npm

Alternatively, install ChinaHoliday as a dependency in your Node.js project via npm:

npm install china-holiday

Usage

In Node.js

Assuming you've installed the china-holiday package via npm, you can use it in your project like so:

const { findChinaHolidayByYears } = require("china-holiday");

// Query holidays and adjusted days for a specific year
findChinaHolidayByYears(2023)
  .then((holidays) => {
    console.log(holidays);
  })
  .catch((error) => {
    console.error("Failed to fetch:", error);
  });

In Front-end Projects

If you've included the JSON data via unpkg, you can directly use this data in your front-end code.

API Reference

findChinaHolidayByYears(year)

• year {Number} - The year for which to query holidays and adjusted days.
• Returns {Promise} - A Promise that resolves to an array of holidays and adjusted days for the specified year.

This function is used to query the official public holidays and adjusted working days for a specified year.

Data Source

All holiday and adjusted day data is fetched from https://date.appworlds.cn/year/{year}, and we strive to ensure the data is continuously updated and accurate.

Contributing

Contributions to ChinaHoliday are welcome, whether it's updating data, adding new features, or improving documentation. We appreciate your efforts!

License

ChinaHoliday is released under the MIT License. See the LICENSE file for more information.

Please note, when using this library, you may need to comply with relevant laws and regulations.