Documentation / @jalali-js/holidays

@jalali-js/holidays

Offline Iran (IR) public holidays for jalali-js. AF and TJ are reserved. Fixed solar days use rules. Lunar days use a per-year table. Zero runtime dependencies.

npm install @jalali-js/holidays

import { isHoliday, holidaysOn } from '@jalali-js/holidays';

isHoliday({ year: 1403, month: 1, day: 1 }); // Nowruz (Iran)
holidaysOn({ year: 1403, month: 1, day: 1 }, { region: 'IR' });

Layout:

• regions/ir/fixed.ts: solar Jalali rules
• data/ir/lunar/*.json: lunar rows (codegen to lunar-table.ts)
• regions/ir/names/{en,fa,ps}.ts: one language per file
• regions/ir/ids.ts: fixed and lunar ids

Pickers take showHolidays, blockHolidays, and holidayRegion (default 'IR').

make update-holidays YEARS=next
make update-holidays

Guide · Playground

MIT licensed.

Interfaces

• CalendarHolidayOptions
• Holiday
• HolidayDateFields
• HolidayNames
• HolidayOccurrence
• HolidayQueryOptions
• HolidaySelectionRules
• RegionHolidayPack
• ResolvedCalendarHolidays

Type Aliases

• HolidayId
• HolidayLocale
• HolidayRegion

Variables

• DEFAULT_HOLIDAY_REGION
• HOLIDAY_REGIONS
• HOLIDAY_YEAR_RANGE
• SHIPPED_HOLIDAY_REGIONS

Functions

• holidayDatesAround
• holidayName
• holidayNames
• holidayPackFor
• holidaysInMonth
• holidaysInYear
• holidaysOn
• holidayYearRange
• isHoliday
• isHolidayRegion
• isShippedHolidayRegion
• resolveCalendarHolidays
• withHolidaysBlocked