@hyunbinseo/holidays-kr NPM

South Korea's National Holidays

Yearly updated based on the official gazette. Available in npm and jsDelivr.

Migration

2.x

- import { isHoliday } from '@hyunbinseo/holidays-kr/check';
+ import { isHoliday } from '@hyunbinseo/holidays-kr';

- const { isHoliday } = require('@hyunbinseo/holidays-kr/check');
+ const { isHoliday } = require('@hyunbinseo/holidays-kr');

Usage

Yearly holidays are provided as a JavaScript Map. Reference

import { y2023 } from '@hyunbinseo/holidays-kr';
// const { y2023 } = require('@hyunbinseo/holidays-kr');

y2023.has('2023-01-01'); // true
y2023.has('2023-01-02'); // false

for (const [date, subject] of y2023) {
  console.log(date, subject);
  // 2023-01-01 1월 1일
  // 2023-01-21 설날 전날
  // …
}

[...y2023.keys()]; // ['2023-01-01', '2023-01-21', … ]
[...y2023.values()]; // ['1월 1일', '설날 전날', … ]

Check if a JavaScript Date is a holiday. Be careful with the date's timezone.

import { isHoliday } from '@hyunbinseo/holidays-kr';
// const { isHoliday } = require('@hyunbinseo/holidays-kr');

// +0900 is equivalent to the Asia/Seoul timezone.
isHoliday(new Date('2023-01-01T00:00:00.000+0900')); // true

const date = new Date('2023-01-07T00:00:00.000+0900'); // Saturday
isHoliday(date, { include: { saturday: true } }); // true
isHoliday(date, { include: { sunday: true } }); // false
isHoliday(date); // false

isHoliday(new Date('2023-01-01T00:00:00.000+1000')); // false
// Sat Dec 31 2022 23:00:00 GMT+0900 is not a holiday.

isHoliday(new Date('2000-01-01T00:00:00.000+0900')); // null
// Holiday information of the year 2000 is not included.
// Therefore, cannot determine if the date is a holiday.

isHoliday('2023-01-01'); // TypeError

type Options = {
  include: Partial<{
    saturday: boolean;
    sunday: boolean;
  }>;
};

export declare const isHoliday: (
  date: Date,
  options?: Options
) => boolean | null | TypeError;