best-holiday

Holidays and JavaScript; now Customizable and Effortless

About

Best-Holiday aims to make it easier for developers to interact with holidays in their applications. Best-Holiday can be used via the npm package or through the CDN for browser use.

The list of holidays can be found in src/index.ts. Holidays have four attributes:

• name: Name of the holiday
• date: Date of the holiday
• country: Country where the holiday is
• type: Type of the holiday

Installation

Installing Best-Holiday is simple.

npm In your project directory, run:

npm install best-holiday

yarn In your project directory, run:

yarn add best-holiday

If you want to use Best-Holiday in the browser environment, include this script tag in your HTML document:

<script src="https://cdn.jsdelivr.net/npm/best-holiday@latest/dist/browser/best-holiday.min.js"></script>

Usage

The Best-Holiday package currently exports six main functions:

• getHolidaysForDays: Returns an array of holidays for a given date
• getHolidaysInRange: Returns an array of holidays for a given range
• searchHolidays: Returns an array of holidays for a given search query
• getEasterRelatedHoliday: Returns the Easter related holiday
• addHoliday: Adds a new holiday
• removeHoliday: Removes a holiday

For more detailed information about usage, refer to the Wiki.

License

GPL-3.0-or-later

Contributors

• The-Best-Codes

© 2024 The-Best-Codes