README

Welcome to holidate 📅

JS library for calculating and validating holidays

🏠 Homepage

Install

npm install holidate

Usage

const holidate = require('holidate');

let holidays = holidate.getHolidays();

Example output

[
    {
        "name": "New Year's Day",
        "tags": [ "federal" ],
        "natural": true,
        "date": "2021-01-01T07:00:00.000Z"
    },
    {
        "name": "Martin Luther King Jr. Day",
        "tags": [ "federal" ],
        "natural": true,
        "date": "2021-01-18T07:00:00.000Z"
    },
    {
        "name": "Washington's Birthday",
        "tags": [ "federal" ],
        "natural": true,
        "date": "2021-02-15T07:00:00.000Z"
    },
    {
        "name": "Memorial Day",
        "tags": [ "federal" ],
        "natural": true,
        "date": "2021-05-31T07:00:00.000Z"
    },
    {
        "name": "Juneteenth National Independence Day (observed)",
        "tags": [ "federal" ],
        "natural": false,
        "date": "2021-06-18T07:00:00.000Z"
    },
    {
        "name": "Juneteenth National Independence Day",
        "tags": [ "federal" ],
        "natural": true,
        "date": "2021-06-19T07:00:00.000Z"
    },
    // ...
]

API

getHolidays(year, country, language)

Parameter	Type	Description
year	number	The holidays for this year will be returned. Defaults to the current year.
country	string	The ISO 3166-1 alpha 2 country code. Defaults to 'US'.
language	string	The ISO 639-1 language code for the language the holiday names will be returned in. Defaults to 'en'.

Response

Array of holiday objects

Holiday

Field	Type	Description
name	string	Name of the holiday.
tags	array of strings	Descriptors that can be used to filter the holiday list. For example, Easter in the United States has these tags: `[ 'non-federal', 'religious', 'christianity' ]`
natural	boolean	Whether the holiday object represents the actual holiday date or the date it is being observed in a given year. For example if the holiday falls on a weekend but is observed on a weekday to preserve the work holiday.
date	Date	Date of the holiday.

Author

👤 zachnology

Github: @zachnology

🤝 Contributing

Contributions, issues and feature requests are welcome!

Feel free to check issues page. You can also take a look at the contributing guide.

Show your support

Give a ⭐️ if this project helped you!

📝 License

This project is MIT licensed.

This README was generated with ❤️ by readme-md-generator

Usage no npm install needed!