fridagar
Advanced tools
Changelog
4.2.2
2024-02-26
pkg.exports fieldReadme
Small, fast JavaScript/TypeScript library for looking up Icelandic public holidays, and resolving business days before/after a given day. It also provides info about other commonly observed "special" days such as "Bolludagur", etc.
"Half day" holidays (such as Christmas and New Year's Eve) are marked as such, and can be optionally treated as either "work days" or "non-work days", depending on need.
All day names/descriptions are in Icelandic, but each day has a stable key
prop that can be used when translating its name into other languages.
All returned dates are in the UTC timezone and set to midnight.
npm install fridagar
Contents:
getHolidaysSyntax: getHolidays(year?: number, month?: number): Array<Holiday>
Returns all Icelandic public holidays and commonly celebrated "special" days for a given year — optionally narrowed down to a single month.
import { getHolidays } from "fridagar";
const holidays2018 = getHolidays(2018);
const holidaysInDecember2018 = getHolidays(2018, 12);
// If year is omitted the current year is used
const holidaysThisYear = getHolidays();
const holidaysInDecemberThisYear = getHolidays(undefined, 12);
getAllDaysSyntax:
getAlldays(year?: number, month?: number): Array<Holiday | SpecialDay>
Returns all official Icelandic public holidays (non-working days) for a given year — optionally narrowed down to a single month.
import { getAllDays } from "fridagar";
const allDays2018 = getAllDays(2018);
const allDaysInDecember2018 = getAllDays(2018, 12);
// If year is omitted the current year is used
const allDaysThisYear = getAllDays();
const allDaysInDecemberThisYear = getAllDays(undefined, 12);
getAllDaysKeyedSyntax:
getAllDaysKeyed(year?: number): Record<DayKey, Holiday | SpecialDay>
Returns a keyed object with Icelandic public holidays and commonly celebrated "special" days for a given year. (Defaults to the current year.)
import type { Holiday, SpecialDay } from "fridagar";
import { getAllDaysKeyed } from "fridagar";
const allDays1995 = getAllDaysKeyed(1995);
// Note that the days are correctly typed
const easter95: Holiday = allDays1995.paska;
const ashWed95: SpecialDay = allDays1995.osku;
console.log(easter95.date);
// Logs new Date('1995-04-23')
console.log(easter95.description);
// Logs "Páskadagur"
getOtherDaysSyntax: getOtherDays(year?: number, month?: number): Array<SpecialDay>
Returns only unofficial, commonly celebrated "special days" (that are still workdays) for a given year — optionally narrowed down to a single month.
import { getOtherDays } from "fridagar";
const otherdays2018 = getOtherDays(2018);
const otherdaysInDecember2018 = getOtherDays(2018, 12);
// If year is omitted the current year is used
const otherdaysThisYear = getOtherDays();
const otherdaysInDecemberThisYear = getOtherDays(undefined, 12);
isHolidaySyntax: isHoliday(date: Date): Holiday | undefined
Checks if a given date is an Icelandic public holiday, and if so, returns its info object.
import { isHoliday } from "fridagar";
const res1 = isHoliday(new Date("2018-12-24"));
console.log(res1);
// Logs the `Holiday` object for Aðfangadagur
const res2 = isHoliday(new Date("2018-12-23"));
console.log(res2);
// Logs `undefined` (as Þorláksmessa is not a holiday.)
isSpecialDaySyntax: isSpecialDay(date: Date): Holiday | SpecialDay | undefined
Checks if a given date is either an Icelandic public holiday or a commonly celebrated "special" day, and if so, returns its info object.
import { isSpecialDay } from "fridagar";
const res1 = isSpecialDay(new Date("2018-12-24"));
console.log(res1);
// Logs the `Holiday` object for Aðfangadagur
const res2 = isSpecialDay(new Date("2018-12-23"));
console.log(res2);
// Logs the `SpecialDay` object for Þorláksmessa
const res3 = isSpecialDay(new Date("2018-12-19"));
console.log(res3);
// Logs `undefined` (Because Dec. 19th is just a normal day.)
workdaysFromDateSyntax:
workdaysFromDate(days: number, refDate?: Date, includeHalfDays?: boolean): Date
Returns the days-th business-day before/after the reference date.
Defaults to counting half-day holidays as "non-work" days.
import { workdaysFromDate } from "fridagar";
const dec23th2018 = new Date("2018-12-23"); // Thursday
const jan1st2025 = new Date("2024-01-01"); // Tuesday
// Treats Aðfangadagur as a non-work day by default
const secondWorkDay = workdaysFromDate(2, dec23th2018);
// new Date('2021-12-28') // Tuesday
// Optionally treats Aðfangadagur as a work day
const secondWorkDayInclHalfDay = workdaysFromDate(2, dec23th2018, true);
// new Date('2021-12-27') // Monday
// One business days before New Year's day of 2024
const prevDay = workdaysFromDate(-1, jan1st2024);
// new Date('2023-12-29') // Friday
If the refDate is omitted, the current (today) date is used.
const thirdWorkDayFromToday = workdaysFromDate(3);
NOTE: The returned date is always set to 00:00:00 UTC.
These are the supported days and their identification keys:
nyars)threttand)bonda)bollu)sprengi)osku)valent)konu)skir)foslangi)paska)paska2)sumar1)mai1)uppst)hvitas)hvitas2)sjomanna)jun17)sumsolst)jonsm)verslm)vetur1)hrekkja)isltungu)fullv)vetsolst)thorl)adfanga)jola)jola2)gamlars)What to include is always subjective.
Currently the list focuses on:
This means "Valentínusardagur" is a bit of an oddball in this list. It's inclusion begs the question why we don't include other similar days such as "Mæðradagurinn", "Feðradagurinn", or even "Singles Day". Or should it be removed?
The "on the fence" category includes:
Example: "Dagur íslenskrar tungu" was first celebrated in 1996. Should
getAllDays(1980) include it or not?
Problem is that many days don't have a definite starting date, they just faded into existence over time. Other days (such as "Mæðradagurinn") have had different dates at different times.
Currently the library does NOT aim for historical accuracy, and will return all "modern day" special days for any year — and completely ignore the fact that "Frídagur verslunarmanna in the year 345 BC" makes absolutely no sense.
HolidayAn object describing an Icelandic public holiday.
import type { Holiday } from "fridagar";
// Example
const xmasEve2017: Holiday = {
date: new Date("2017-12-24T00:00:00.000Z"),
description: "Aðfangadagur",
key: "adfanga", // stable identifier for this holiday
holiday: true,
halfDay: true,
};
NOTE: All dates are set to 00:00:00 UTC
SpecialDayAn object describing an Icelandic commonly celebrated "special" day, such as "Bolludagur", etc.
import type { SpecialDay } from "fridagar";
// Example
const sovereignDay2017: SpecialDay = {
date: new Date("2017-12-01T00:00:00.000Z"),
description: "Fullveldisdagurinn",
key: "fullv", // stable identifier for this special day
holiday: false, // not a public holiday
};
NOTE: All dates are set to 00:00:00 UTC
DayKey, HolidayKey, SpecialDayKeyString union types of all possible key values for Holiday and
SpecialDay objects. These are mainly useful when translating the day
names/descriptions into other languages.
import type { DayKey, HolidayKey, SpecialDayKey } from "fridagar";
const holidayNamesPolish: Record<HolidayKey, string> = {
nyars: "Nowy Rok",
adfanga: "Wigilia",
jola: "Boże Narodzenie",
// etc...
};
const specialDayNamesPolish: Record<SpecialDayKey, string> = {
bollu: "Dzień Pączka",
sjomanna: "Dzień Marynarza",
// etc...
};
// DayKey is a shorthand union of HolidayKey and SpecialDayKey
const allDayNamesPolish: Record<DayKey, string> = {
...holidayNamesPolish,
...specialDayNamesPolish,
};
This project uses the Bun runtime for development (tests, build, etc.)
PRs are welcoms!
See CHANGELOG.md
is-kennitala - Best-of-breed kennitala (Icelandic national ID) validation and utility library.postnumer - Icelandic post-codes (Póstnúmer) and town/locality names and their National Registry ID codes.FAQs
Small library for looking up Icelandic public holidays and other commonly observed 'special' days.
The npm package fridagar receives a total of 648 weekly downloads. As such, fridagar popularity was classified as not popular.
We found that fridagar demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.
Security News
GitHub is susceptible to a CDN flaw that allows attackers to host malware on any public repository.