date-fns-holiday-us - npm Package Compare versions

Comparing version 0.3.1 to 1.0.0

dist/index.d.ts

@@ -1,21 +0,21 @@
-export declare type Holiday = "christmas" | "easter" | "halloween" | "valentinesDay" | "mothersDay" | "columbusDay" | "independenceDay" | "presidentsDay" | "laborDay" | "veteransDay" | "thanksgiving" | "newYearsEve" | "martinLutherKingJrDay" | "newYearsDay" | "fathersDay" | "memorialDay" | "goodFriday" | "juneteenth";
-export declare function getHalloween(year: number): Date;
-export declare function getValentinesDay(year: number): Date;
-export declare function getMothersDay(year: number): Date;
-export declare function getJuneteenth(year: number): Date;
-export declare function getEaster(year: number): Date;
-export declare function getColumbusDay(year: number): Date;
-export declare function getIndependenceDay(year: number): Date;
-export declare function getPresidentsDay(year: number): Date;
-export declare function getChristmas(year: number): Date;
-export declare function getLaborDay(year: number): Date;
-export declare function getVeteransDay(year: number): Date;
-export declare function getThanksgiving(year: number): Date;
-export declare function getNewYearsEve(year: number): Date;
-export declare function getMartinLutherKingJrDay(year: number): Date;
-export declare function getNewYearsDay(year: number): Date;
-export declare function getFathersDay(year: number): Date;
-export declare function getMemorialDay(year: number): Date;
-export declare function getGoodFriday(year: number): Date;
-export declare type Holidays = {
+declare type Holiday = "christmas" | "easter" | "halloween" | "valentinesDay" | "mothersDay" | "columbusDay" | "independenceDay" | "presidentsDay" | "laborDay" | "veteransDay" | "thanksgiving" | "newYearsEve" | "martinLutherKingJrDay" | "newYearsDay" | "fathersDay" | "memorialDay" | "goodFriday" | "juneteenth";
+declare function getHalloween(year: number): Date;
+declare function getValentinesDay(year: number): Date;
+declare function getMothersDay(year: number): Date;
+declare function getJuneteenth(year: number): Date;
+declare function getEaster(year: number): Date;
+declare function getColumbusDay(year: number): Date;
+declare function getIndependenceDay(year: number): Date;
+declare function getPresidentsDay(year: number): Date;
+declare function getChristmas(year: number): Date;
+declare function getLaborDay(year: number): Date;
+declare function getVeteransDay(year: number): Date;
+declare function getThanksgiving(year: number): Date;
+declare function getNewYearsEve(year: number): Date;
+declare function getMartinLutherKingJrDay(year: number): Date;
+declare function getNewYearsDay(year: number): Date;
+declare function getFathersDay(year: number): Date;
+declare function getMemorialDay(year: number): Date;
+declare function getGoodFriday(year: number): Date;
+declare type Holidays = {
     [K in Holiday]: {
@@ -27,4 +27,4 @@ date: Date;
 };
-export declare function getHolidays(year: number): Holidays;
-export declare function getBankHolidays(year: number): {
+declare function getHolidays(year: number): Holidays;
+declare function getBankHolidays(year: number): {
     [key: string]: {
@@ -34,4 +34,4 @@ date: Date;
 };
-export declare function getObservedHolidays(year: number): Record<string, Record<"date", Date>>;
-export declare function isInHolidayList(date: Date, getHolidayList: (year: number) => {
+declare function getObservedHolidays(year: number): Record<string, Record<"date", Date>>;
+declare function isInHolidayList(date: Date, getHolidayList: (year: number) => {
     [key: string]: {
@@ -41,3 +41,5 @@ date: Date;
 }): boolean;
-export declare function isHoliday(date: Date): boolean;
-export declare function isBankHoliday(date: Date): boolean;
+declare function isHoliday(date: Date): boolean;
+declare function isBankHoliday(date: Date): boolean;
+
+export { Holiday, Holidays, getBankHolidays, getChristmas, getColumbusDay, getEaster, getFathersDay, getGoodFriday, getHalloween, getHolidays, getIndependenceDay, getJuneteenth, getLaborDay, getMartinLutherKingJrDay, getMemorialDay, getMothersDay, getNewYearsDay, getNewYearsEve, getObservedHolidays, getPresidentsDay, getThanksgiving, getValentinesDay, getVeteransDay, isBankHoliday, isHoliday, isInHolidayList };

dist/index.js

@@ -0,8 +1,326 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
-'use strict'
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  getBankHolidays: () => getBankHolidays,
+  getChristmas: () => getChristmas,
+  getColumbusDay: () => getColumbusDay,
+  getEaster: () => getEaster,
+  getFathersDay: () => getFathersDay,
+  getGoodFriday: () => getGoodFriday,
+  getHalloween: () => getHalloween,
+  getHolidays: () => getHolidays,
+  getIndependenceDay: () => getIndependenceDay,
+  getJuneteenth: () => getJuneteenth,
+  getLaborDay: () => getLaborDay,
+  getMartinLutherKingJrDay: () => getMartinLutherKingJrDay,
+  getMemorialDay: () => getMemorialDay,
+  getMothersDay: () => getMothersDay,
+  getNewYearsDay: () => getNewYearsDay,
+  getNewYearsEve: () => getNewYearsEve,
+  getObservedHolidays: () => getObservedHolidays,
+  getPresidentsDay: () => getPresidentsDay,
+  getThanksgiving: () => getThanksgiving,
+  getValentinesDay: () => getValentinesDay,
+  getVeteransDay: () => getVeteransDay,
+  isBankHoliday: () => isBankHoliday,
+  isHoliday: () => isHoliday,
+  isInHolidayList: () => isInHolidayList
+});
+module.exports = __toCommonJS(src_exports);
+var import_date_fns2 = require("date-fns");
 
-if (process.env.NODE_ENV === 'production') {
-  module.exports = require('./date-fns-holiday-us.cjs.production.min.js')
-} else {
-  module.exports = require('./date-fns-holiday-us.cjs.development.js')
+// src/utils.ts
+var import_date_fns = require("date-fns");
+function getFirstOccurence(date, dayOfWeekIndex) {
+  return getNextOccurence((0, import_date_fns.setDate)(date, 1), dayOfWeekIndex);
 }
+function getNextOccurence(date, dayOfWeekIndex) {
+  if ((0, import_date_fns.getDay)(date) === dayOfWeekIndex) {
+    return date;
+  }
+  if ((0, import_date_fns.getDay)(date) > dayOfWeekIndex) {
+    date = (0, import_date_fns.addDays)(date, 7 - (0, import_date_fns.getDay)(date) + dayOfWeekIndex);
+  } else {
+    date = (0, import_date_fns.addDays)(date, dayOfWeekIndex - (0, import_date_fns.getDay)(date));
+  }
+  return date;
+}
+function getPrevOccurence(date, dayOfWeekIndex) {
+  if ((0, import_date_fns.getDay)(date) === dayOfWeekIndex) {
+    return date;
+  }
+  if ((0, import_date_fns.getDay)(date) > dayOfWeekIndex) {
+    date = (0, import_date_fns.addDays)(date, -1 * ((0, import_date_fns.getDay)(date) - dayOfWeekIndex));
+  } else {
+    date = (0, import_date_fns.addDays)(date, -1 * ((0, import_date_fns.getDay)(date) - 0 + (7 - dayOfWeekIndex)));
+  }
+  return date;
+}
+function getLastOfMonth(date, dayOfWeekIndex) {
+  return getPrevOccurence((0, import_date_fns.lastDayOfMonth)(date), dayOfWeekIndex);
+}
+
+// src/index.ts
+function getHalloween(year) {
+  return new Date(year, 9, 31);
+}
+function getValentinesDay(year) {
+  return new Date(year, 1, 14);
+}
+function getMothersDay(year) {
+  return (0, import_date_fns2.addWeeks)(getFirstOccurence(new Date(year, 4), 0), 1);
+}
+function getJuneteenth(year) {
+  return new Date(year, 5, 19);
+}
+function getEaster(year) {
+  if (year < 325) {
+    throw new RangeError("Cannot calculate Easter dates before 325 AD.");
+  }
+  function mod(a2, b2) {
+    return a2 % b2;
+  }
+  function div(a2, b2) {
+    const q = a2 / b2;
+    if (q < 0) {
+      throw new Error("Unexpected negative q");
+    }
+    return Math.floor(q);
+  }
+  const y = year, skipMarchDays = 21, a = mod(y, 19), b = div(y, 100), c = mod(y, 100), d = div(b, 4), e = mod(b, 4), f = div(b + 8, 25), g = div(b - f + 1, 3), h = mod(19 * a + b - d - g + 15, 30), i = div(c, 4), k = mod(c, 4), l = mod(32 + 2 * e + 2 * i - h - k, 7), m = div(a + 11 * h + 22 * l, 451), t = h + l - 7 * m + skipMarchDays, n = div(t, 31) + 3, p = mod(t, 31);
+  return new Date(year, n - 1, p + 1);
+}
+function getColumbusDay(year) {
+  return (0, import_date_fns2.addWeeks)(getFirstOccurence(new Date(year, 9), 1), 1);
+}
+function getIndependenceDay(year) {
+  return new Date(year, 6, 4);
+}
+function getPresidentsDay(year) {
+  return (0, import_date_fns2.addWeeks)(getFirstOccurence(new Date(year, 1), 1), 2);
+}
+function getChristmas(year) {
+  return new Date(year, 11, 25);
+}
+function getLaborDay(year) {
+  return getFirstOccurence(new Date(year, 8), 1);
+}
+function getVeteransDay(year) {
+  return new Date(year, 10, 11);
+}
+function getThanksgiving(year) {
+  return (0, import_date_fns2.addWeeks)(getFirstOccurence(new Date(year, 10), 4), 3);
+}
+function getNewYearsEve(year) {
+  return (0, import_date_fns2.lastDayOfMonth)(new Date(year, 11));
+}
+function getMartinLutherKingJrDay(year) {
+  return (0, import_date_fns2.addWeeks)(getFirstOccurence(new Date(year, 0), 1), 2);
+}
+function getNewYearsDay(year) {
+  return new Date(year, 0, 1);
+}
+function getFathersDay(year) {
+  return (0, import_date_fns2.addWeeks)(getFirstOccurence(new Date(year, 5), 0), 2);
+}
+function getMemorialDay(year) {
+  return getLastOfMonth(new Date(year, 4), 1);
+}
+function getGoodFriday(year) {
+  return (0, import_date_fns2.addDays)(getEaster(year), -2);
+}
+function getHolidays(year) {
+  return {
+    newYearsDay: {
+      date: getNewYearsDay(year),
+      bankHoliday: true,
+      observed: false
+    },
+    martinLutherKingJrDay: {
+      date: getMartinLutherKingJrDay(year),
+      bankHoliday: true,
+      observed: false
+    },
+    valentinesDay: {
+      date: getValentinesDay(year),
+      bankHoliday: false,
+      observed: false
+    },
+    juneteenth: {
+      date: getJuneteenth(year),
+      bankHoliday: year < 2022 ? false : true,
+      observed: true
+    },
+    easter: {
+      date: getEaster(year),
+      bankHoliday: false,
+      observed: false
+    },
+    presidentsDay: {
+      date: getPresidentsDay(year),
+      bankHoliday: true,
+      observed: false
+    },
+    memorialDay: {
+      date: getMemorialDay(year),
+      bankHoliday: true,
+      observed: false
+    },
+    independenceDay: {
+      date: getIndependenceDay(year),
+      bankHoliday: true,
+      observed: true
+    },
+    laborDay: {
+      date: getLaborDay(year),
+      bankHoliday: true,
+      observed: false
+    },
+    goodFriday: {
+      date: getGoodFriday(year),
+      bankHoliday: false,
+      observed: false
+    },
+    mothersDay: {
+      date: getMothersDay(year),
+      bankHoliday: false,
+      observed: false
+    },
+    columbusDay: {
+      date: getColumbusDay(year),
+      bankHoliday: true,
+      observed: false
+    },
+    halloween: {
+      date: getHalloween(year),
+      bankHoliday: false,
+      observed: false
+    },
+    fathersDay: {
+      date: getFathersDay(year),
+      bankHoliday: false,
+      observed: false
+    },
+    veteransDay: {
+      date: getVeteransDay(year),
+      bankHoliday: true,
+      observed: false
+    },
+    thanksgiving: {
+      date: getThanksgiving(year),
+      bankHoliday: true,
+      observed: false
+    },
+    christmas: {
+      date: getChristmas(year),
+      bankHoliday: true,
+      observed: false
+    },
+    newYearsEve: {
+      date: getNewYearsEve(year),
+      bankHoliday: false,
+      observed: false
+    }
+  };
+}
+function getBankHolidays(year) {
+  const holidays = getHolidays(year);
+  return Object.keys(holidays).reduce((acc, holidayName) => {
+    const holiday = holidays[holidayName];
+    if (holiday.bankHoliday) {
+      return {
+        ...acc,
+        [holidayName]: {
+          date: holiday.date
+        }
+      };
+    }
+    return acc;
+  }, {});
+}
+function getObservedHolidays(year) {
+  const holidays = getHolidays(year);
+  return Object.keys(holidays).filter((holidayName) => {
+    if (holidays[holidayName].observed)
+      return true;
+    return false;
+  }).reduce((acc, holidayName) => {
+    const holiday = holidays[holidayName];
+    if ((0, import_date_fns2.isSaturday)(holiday.date)) {
+      return {
+        ...acc,
+        [holidayName]: {
+          date: (0, import_date_fns2.addDays)(holiday.date, -1)
+        }
+      };
+    }
+    if ((0, import_date_fns2.isSunday)(holiday.date)) {
+      return {
+        ...acc,
+        [holidayName]: {
+          date: (0, import_date_fns2.addDays)(holiday.date, 1)
+        }
+      };
+    }
+    return acc;
+  }, {});
+}
+function isInHolidayList(date, getHolidayList) {
+  const holidays = getHolidayList((0, import_date_fns2.getYear)(date));
+  return Object.keys(holidays).filter((holidayName) => {
+    return (0, import_date_fns2.isEqual)(date, holidays[holidayName].date);
+  }).length > 0;
+}
+function isHoliday(date) {
+  return isInHolidayList(date, getHolidays);
+}
+function isBankHoliday(date) {
+  return isInHolidayList(date, getBankHolidays);
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  getBankHolidays,
+  getChristmas,
+  getColumbusDay,
+  getEaster,
+  getFathersDay,
+  getGoodFriday,
+  getHalloween,
+  getHolidays,
+  getIndependenceDay,
+  getJuneteenth,
+  getLaborDay,
+  getMartinLutherKingJrDay,
+  getMemorialDay,
+  getMothersDay,
+  getNewYearsDay,
+  getNewYearsEve,
+  getObservedHolidays,
+  getPresidentsDay,
+  getThanksgiving,
+  getValentinesDay,
+  getVeteransDay,
+  isBankHoliday,
+  isHoliday,
+  isInHolidayList
+});
+//# sourceMappingURL=index.js.map

package.json

 {
   "name": "date-fns-holiday-us",
   "description": "The purpose of this project is to give an interface to work with holidays using date-fns",
-  "version": "0.3.1",
+  "version": "1.0.0",
   "author": "Jon Stuebe",
   "license": "MIT",
   "main": "dist/index.js",
-  "module": "dist/date-fns-holiday-us.esm.js",
+  "module": "dist/esm/index.js",
+  "browser": "dist/iife/index.js",
   "typings": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "require": "./dist/index.js",
+      "import": "./dist/esm/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
   "keywords": [
@@ -23,8 +31,8 @@ "date-fns",
   "scripts": {
-    "start": "tsdx watch",
-    "build": "tsdx build",
-    "test": "tsdx test",
-    "lint": "tsdx lint",
+    "start": "tsup --watch",
+    "build": "tsup",
+    "test": "jest",
+    "lint": "eslint ./src",
     "docs": "node scripts/docs",
-    "prepare": "tsdx build && yarn docs"
+    "prepublishOnly": "yarn build && yarn docs"
   },
@@ -36,3 +44,3 @@ "peerDependencies": {
     "hooks": {
-      "pre-commit": "tsdx lint"
+      "pre-commit": "yarn lint"
     }
@@ -47,13 +55,22 @@ },
   "devDependencies": {
-    "@types/jest": "^26.0.23",
+    "@swc/core": "^1.3.0",
+    "@swc/jest": "^0.2.22",
+    "@types/jest": "^29.0.2",
+    "@typescript-eslint/eslint-plugin": "^5.37.0",
+    "@typescript-eslint/parser": "^5.37.0",
     "chalk": "^4.1.1",
-    "date-fns": "^2.22.1",
-    "husky": "^4.2.3",
+    "date-fns": "^2.29.3",
+    "eslint": "^8.23.1",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-plugin-prettier": "^4.2.1",
+    "husky": "^8.0.1",
+    "jest": "^29.0.3",
+    "prettier": "^2.7.1",
     "rimraf": "^3.0.2",
-    "tsdx": "^0.14.1",
-    "tslib": "^2.3.0",
-    "typedoc": "^0.16.9",
-    "typedoc-plugin-markdown": "^2.2.16",
-    "typescript": "^4.3.4"
+    "tslib": "^2.4.0",
+    "tsup": "^6.2.3",
+    "typedoc": "^0.23.14",
+    "typedoc-plugin-markdown": "^3.13.6",
+    "typescript": "^4.8.3"
   }
 }

README.md

@@ -18,526 +18,537 @@
 
-## API
+## Table of contents
 
-### Type aliases
+### Type Aliases
 
-* [Holiday](README.md#holiday)
-* [Holidays](README.md#holidays)
+- [Holiday](README.md#holiday)
+- [Holidays](README.md#holidays)
 
 ### Functions
 
-* [getBankHolidays](README.md#getbankholidays)
-* [getChristmas](README.md#getchristmas)
-* [getColumbusDay](README.md#getcolumbusday)
-* [getEaster](README.md#geteaster)
-* [getFathersDay](README.md#getfathersday)
-* [getFirstOccurence](README.md#getfirstoccurence)
-* [getGoodFriday](README.md#getgoodfriday)
-* [getHalloween](README.md#gethalloween)
-* [getHolidays](README.md#getholidays)
-* [getIndependenceDay](README.md#getindependenceday)
-* [getJuneteenth](README.md#getjuneteenth)
-* [getLaborDay](README.md#getlaborday)
-* [getLastOfMonth](README.md#getlastofmonth)
-* [getMartinLutherKingJrDay](README.md#getmartinlutherkingjrday)
-* [getMemorialDay](README.md#getmemorialday)
-* [getMothersDay](README.md#getmothersday)
-* [getNewYearsDay](README.md#getnewyearsday)
-* [getNewYearsEve](README.md#getnewyearseve)
-* [getNextOccurence](README.md#getnextoccurence)
-* [getObservedHolidays](README.md#getobservedholidays)
-* [getPresidentsDay](README.md#getpresidentsday)
-* [getPrevOccurence](README.md#getprevoccurence)
-* [getThanksgiving](README.md#getthanksgiving)
-* [getValentinesDay](README.md#getvalentinesday)
-* [getVeteransDay](README.md#getveteransday)
-* [isBankHoliday](README.md#isbankholiday)
-* [isHoliday](README.md#isholiday)
-* [isInHolidayList](README.md#isinholidaylist)
+- [getBankHolidays](README.md#getbankholidays)
+- [getChristmas](README.md#getchristmas)
+- [getColumbusDay](README.md#getcolumbusday)
+- [getEaster](README.md#geteaster)
+- [getFathersDay](README.md#getfathersday)
+- [getGoodFriday](README.md#getgoodfriday)
+- [getHalloween](README.md#gethalloween)
+- [getHolidays](README.md#getholidays)
+- [getIndependenceDay](README.md#getindependenceday)
+- [getJuneteenth](README.md#getjuneteenth)
+- [getLaborDay](README.md#getlaborday)
+- [getMartinLutherKingJrDay](README.md#getmartinlutherkingjrday)
+- [getMemorialDay](README.md#getmemorialday)
+- [getMothersDay](README.md#getmothersday)
+- [getNewYearsDay](README.md#getnewyearsday)
+- [getNewYearsEve](README.md#getnewyearseve)
+- [getObservedHolidays](README.md#getobservedholidays)
+- [getPresidentsDay](README.md#getpresidentsday)
+- [getThanksgiving](README.md#getthanksgiving)
+- [getValentinesDay](README.md#getvalentinesday)
+- [getVeteransDay](README.md#getveteransday)
+- [isBankHoliday](README.md#isbankholiday)
+- [isHoliday](README.md#isholiday)
+- [isInHolidayList](README.md#isinholidaylist)
 
-## Type aliases
+## Type Aliases
 
-###  Holiday
+### Holiday
 
-Ƭ **Holiday**: *"christmas" | "easter" | "halloween" | "valentinesDay" | "mothersDay" | "columbusDay" | "independenceDay" | "presidentsDay" | "laborDay" | "veteransDay" | "thanksgiving" | "newYearsEve" | "martinLutherKingJrDay" | "newYearsDay" | "fathersDay" | "memorialDay" | "goodFriday" | "juneteenth"*
+Ƭ **Holiday**: ``"christmas"`` \| ``"easter"`` \| ``"halloween"`` \| ``"valentinesDay"`` \| ``"mothersDay"`` \| ``"columbusDay"`` \| ``"independenceDay"`` \| ``"presidentsDay"`` \| ``"laborDay"`` \| ``"veteransDay"`` \| ``"thanksgiving"`` \| ``"newYearsEve"`` \| ``"martinLutherKingJrDay"`` \| ``"newYearsDay"`` \| ``"fathersDay"`` \| ``"memorialDay"`` \| ``"goodFriday"`` \| ``"juneteenth"``
 
-*Defined in [index.ts:13](https://github.com/jonstuebe/date-fns-holiday-us/blob/master/src/index.ts#L13)*
+#### Defined in
 
+[index.ts:13](https://github.com/jonstuebe/date-fns-holiday-us/blob/master/src/index.ts#L13)
+
 ___
 
-###  Holidays
+### Holidays
 
-Ƭ **Holidays**: *object*
+Ƭ **Holidays**: { [K in Holiday]: Object }
 
-*Defined in [index.ts:139](https://github.com/jonstuebe/date-fns-holiday-us/blob/master/src/index.ts#L139)*
+#### Defined in
 
-#### Type declaration:
+[index.ts:139](https://github.com/jonstuebe/date-fns-holiday-us/blob/master/src/index.ts#L139)
 
 ## Functions
 
-###  getBankHolidays
+### getBankHolidays
 
-▸ **getBankHolidays**(`year`: number): *object*
+▸ **getBankHolidays**(`year`): `Object`
 
-*Defined in [index.ts:242](https://github.com/jonstuebe/date-fns-holiday-us/blob/master/src/index.ts#L242)*
+#### Parameters
 
-**Parameters:**
+| Name | Type |
+| :------ | :------ |
+| `year` | `number` |
 
-Name | Type |
------- | ------ |
-`year` | number |
+#### Returns
 
-**Returns:** *object*
+`Object`
 
-* \[ **key**: *string*\]: object
+#### Defined in
 
-* **date**: *Date*
+[index.ts:242](https://github.com/jonstuebe/date-fns-holiday-us/blob/master/src/index.ts#L242)
 
 ___
 
-###  getChristmas
+### getChristmas
 
-▸ **getChristmas**(`year`: number): *Date*
+▸ **getChristmas**(`year`): `Date`
 
-*Defined in [index.ts:99](https://github.com/jonstuebe/date-fns-holiday-us/blob/master/src/index.ts#L99)*
+#### Parameters
 
-**Parameters:**
+| Name | Type |
+| :------ | :------ |
+| `year` | `number` |
 
-Name | Type |
------- | ------ |
-`year` | number |
+#### Returns
 
-**Returns:** *Date*
+`Date`
 
+#### Defined in
+
+[index.ts:99](https://github.com/jonstuebe/date-fns-holiday-us/blob/master/src/index.ts#L99)
+
 ___
 
-###  getColumbusDay
+### getColumbusDay
 
-▸ **getColumbusDay**(`year`: number): *Date*
+▸ **getColumbusDay**(`year`): `Date`
 
-*Defined in [index.ts:87](https://github.com/jonstuebe/date-fns-holiday-us/blob/master/src/index.ts#L87)*
+#### Parameters
 
-**Parameters:**
+| Name | Type |
+| :------ | :------ |
+| `year` | `number` |
 
-Name | Type |
------- | ------ |
-`year` | number |
+#### Returns
 
-**Returns:** *Date*
+`Date`
 
+#### Defined in
+
+[index.ts:87](https://github.com/jonstuebe/date-fns-holiday-us/blob/master/src/index.ts#L87)
+
 ___
 
-###  getEaster
+### getEaster
 
-▸ **getEaster**(`year`: number): *Date*
+▸ **getEaster**(`year`): `Date`
 
-*Defined in [index.ts:49](https://github.com/jonstuebe/date-fns-holiday-us/blob/master/src/index.ts#L49)*
+#### Parameters
 
-**Parameters:**
+| Name | Type |
+| :------ | :------ |
+| `year` | `number` |
 
-Name | Type |
------- | ------ |
-`year` | number |
+#### Returns
 
-**Returns:** *Date*
+`Date`
 
+#### Defined in
+
+[index.ts:49](https://github.com/jonstuebe/date-fns-holiday-us/blob/master/src/index.ts#L49)
+
 ___
 
-###  getFathersDay
+### getFathersDay
 
-▸ **getFathersDay**(`year`: number): *Date*
+▸ **getFathersDay**(`year`): `Date`
 
-*Defined in [index.ts:127](https://github.com/jonstuebe/date-fns-holiday-us/blob/master/src/index.ts#L127)*
+#### Parameters
 
-**Parameters:**
+| Name | Type |
+| :------ | :------ |
+| `year` | `number` |
 
-Name | Type |
------- | ------ |
-`year` | number |
+#### Returns
 
-**Returns:** *Date*
+`Date`
 
+#### Defined in
+
+[index.ts:127](https://github.com/jonstuebe/date-fns-holiday-us/blob/master/src/index.ts#L127)
+
 ___
 
-###  getFirstOccurence
+### getGoodFriday
 
-▸ **getFirstOccurence**(`date`: Date, `dayOfWeekIndex`: number): *Date*
+▸ **getGoodFriday**(`year`): `Date`
 
-*Defined in [utils.ts:8](https://github.com/jonstuebe/date-fns-holiday-us/blob/master/src/utils.ts#L8)*
+#### Parameters
 
-**Parameters:**
+| Name | Type |
+| :------ | :------ |
+| `year` | `number` |
 
-Name | Type |
------- | ------ |
-`date` | Date |
-`dayOfWeekIndex` | number |
+#### Returns
 
-**Returns:** *Date*
+`Date`
 
+#### Defined in
+
+[index.ts:135](https://github.com/jonstuebe/date-fns-holiday-us/blob/master/src/index.ts#L135)
+
 ___
 
-###  getGoodFriday
+### getHalloween
 
-▸ **getGoodFriday**(`year`: number): *Date*
+▸ **getHalloween**(`year`): `Date`
 
-*Defined in [index.ts:135](https://github.com/jonstuebe/date-fns-holiday-us/blob/master/src/index.ts#L135)*
+#### Parameters
 
-**Parameters:**
+| Name | Type |
+| :------ | :------ |
+| `year` | `number` |
 
-Name | Type |
------- | ------ |
-`year` | number |
+#### Returns
 
-**Returns:** *Date*
+`Date`
 
+#### Defined in
+
+[index.ts:33](https://github.com/jonstuebe/date-fns-holiday-us/blob/master/src/index.ts#L33)
+
 ___
 
-###  getHalloween
+### getHolidays
 
-▸ **getHalloween**(`year`: number): *Date*
+▸ **getHolidays**(`year`): [`Holidays`](README.md#holidays)
 
-*Defined in [index.ts:33](https://github.com/jonstuebe/date-fns-holiday-us/blob/master/src/index.ts#L33)*
+#### Parameters
 
-**Parameters:**
+| Name | Type |
+| :------ | :------ |
+| `year` | `number` |
 
-Name | Type |
------- | ------ |
-`year` | number |
+#### Returns
 
-**Returns:** *Date*
+[`Holidays`](README.md#holidays)
 
+#### Defined in
+
+[index.ts:147](https://github.com/jonstuebe/date-fns-holiday-us/blob/master/src/index.ts#L147)
+
 ___
 
-###  getHolidays
+### getIndependenceDay
 
-▸ **getHolidays**(`year`: number): *[Holidays](README.md#holidays)*
+▸ **getIndependenceDay**(`year`): `Date`
 
-*Defined in [index.ts:147](https://github.com/jonstuebe/date-fns-holiday-us/blob/master/src/index.ts#L147)*
+#### Parameters
 
-**Parameters:**
+| Name | Type |
+| :------ | :------ |
+| `year` | `number` |
 
-Name | Type |
------- | ------ |
-`year` | number |
+#### Returns
 
-**Returns:** *[Holidays](README.md#holidays)*
+`Date`
 
+#### Defined in
+
+[index.ts:91](https://github.com/jonstuebe/date-fns-holiday-us/blob/master/src/index.ts#L91)
+
 ___
 
-###  getIndependenceDay
+### getJuneteenth
 
-▸ **getIndependenceDay**(`year`: number): *Date*
+▸ **getJuneteenth**(`year`): `Date`
 
-*Defined in [index.ts:91](https://github.com/jonstuebe/date-fns-holiday-us/blob/master/src/index.ts#L91)*
+#### Parameters
 
-**Parameters:**
+| Name | Type |
+| :------ | :------ |
+| `year` | `number` |
 
-Name | Type |
------- | ------ |
-`year` | number |
+#### Returns
 
-**Returns:** *Date*
+`Date`
 
-___
+#### Defined in
 
-###  getJuneteenth
+[index.ts:45](https://github.com/jonstuebe/date-fns-holiday-us/blob/master/src/index.ts#L45)
 
-▸ **getJuneteenth**(`year`: number): *Date*
+___
 
-*Defined in [index.ts:45](https://github.com/jonstuebe/date-fns-holiday-us/blob/master/src/index.ts#L45)*
+### getLaborDay
 
-**Parameters:**
+▸ **getLaborDay**(`year`): `Date`
 
-Name | Type |
------- | ------ |
-`year` | number |
+#### Parameters
 
-**Returns:** *Date*
+| Name | Type |
+| :------ | :------ |
+| `year` | `number` |
 
-___
+#### Returns
 
-###  getLaborDay
+`Date`
 
-▸ **getLaborDay**(`year`: number): *Date*
+#### Defined in
 
-*Defined in [index.ts:103](https://github.com/jonstuebe/date-fns-holiday-us/blob/master/src/index.ts#L103)*
+[index.ts:103](https://github.com/jonstuebe/date-fns-holiday-us/blob/master/src/index.ts#L103)
 
-**Parameters:**
+___
 
-Name | Type |
------- | ------ |
-`year` | number |
+### getMartinLutherKingJrDay
 
-**Returns:** *Date*
+▸ **getMartinLutherKingJrDay**(`year`): `Date`
 
-___
+#### Parameters
 
-###  getLastOfMonth
+| Name | Type |
+| :------ | :------ |
+| `year` | `number` |
 
-▸ **getLastOfMonth**(`date`: Date, `dayOfWeekIndex`: number): *Date*
+#### Returns
 
-*Defined in [utils.ts:38](https://github.com/jonstuebe/date-fns-holiday-us/blob/master/src/utils.ts#L38)*
+`Date`
 
-**Parameters:**
+#### Defined in
 
-Name | Type |
------- | ------ |
-`date` | Date |
-`dayOfWeekIndex` | number |
+[index.ts:119](https://github.com/jonstuebe/date-fns-holiday-us/blob/master/src/index.ts#L119)
 
-**Returns:** *Date*
-
 ___
 
-###  getMartinLutherKingJrDay
+### getMemorialDay
 
-▸ **getMartinLutherKingJrDay**(`year`: number): *Date*
+▸ **getMemorialDay**(`year`): `Date`
 
-*Defined in [index.ts:119](https://github.com/jonstuebe/date-fns-holiday-us/blob/master/src/index.ts#L119)*
+#### Parameters
 
-**Parameters:**
+| Name | Type |
+| :------ | :------ |
+| `year` | `number` |
 
-Name | Type |
------- | ------ |
-`year` | number |
+#### Returns
 
-**Returns:** *Date*
+`Date`
 
-___
+#### Defined in
 
-###  getMemorialDay
+[index.ts:131](https://github.com/jonstuebe/date-fns-holiday-us/blob/master/src/index.ts#L131)
 
-▸ **getMemorialDay**(`year`: number): *Date*
+___
 
-*Defined in [index.ts:131](https://github.com/jonstuebe/date-fns-holiday-us/blob/master/src/index.ts#L131)*
+### getMothersDay
 
-**Parameters:**
+▸ **getMothersDay**(`year`): `Date`
 
-Name | Type |
------- | ------ |
-`year` | number |
+#### Parameters
 
-**Returns:** *Date*
+| Name | Type |
+| :------ | :------ |
+| `year` | `number` |
 
-___
+#### Returns
 
-###  getMothersDay
+`Date`
 
-▸ **getMothersDay**(`year`: number): *Date*
+#### Defined in
 
-*Defined in [index.ts:41](https://github.com/jonstuebe/date-fns-holiday-us/blob/master/src/index.ts#L41)*
+[index.ts:41](https://github.com/jonstuebe/date-fns-holiday-us/blob/master/src/index.ts#L41)
 
-**Parameters:**
+___
 
-Name | Type |
------- | ------ |
-`year` | number |
+### getNewYearsDay
 
-**Returns:** *Date*
+▸ **getNewYearsDay**(`year`): `Date`
 
-___
+#### Parameters
 
-###  getNewYearsDay
+| Name | Type |
+| :------ | :------ |
+| `year` | `number` |
 
-▸ **getNewYearsDay**(`year`: number): *Date*
+#### Returns
 
-*Defined in [index.ts:123](https://github.com/jonstuebe/date-fns-holiday-us/blob/master/src/index.ts#L123)*
+`Date`
 
-**Parameters:**
+#### Defined in
 
-Name | Type |
------- | ------ |
-`year` | number |
+[index.ts:123](https://github.com/jonstuebe/date-fns-holiday-us/blob/master/src/index.ts#L123)
 
-**Returns:** *Date*
-
 ___
 
-###  getNewYearsEve
+### getNewYearsEve
 
-▸ **getNewYearsEve**(`year`: number): *Date*
+▸ **getNewYearsEve**(`year`): `Date`
 
-*Defined in [index.ts:115](https://github.com/jonstuebe/date-fns-holiday-us/blob/master/src/index.ts#L115)*
+#### Parameters
 
-**Parameters:**
+| Name | Type |
+| :------ | :------ |
+| `year` | `number` |
 
-Name | Type |
------- | ------ |
-`year` | number |
+#### Returns
 
-**Returns:** *Date*
+`Date`
 
-___
+#### Defined in
 
-###  getNextOccurence
+[index.ts:115](https://github.com/jonstuebe/date-fns-holiday-us/blob/master/src/index.ts#L115)
 
-▸ **getNextOccurence**(`date`: Date, `dayOfWeekIndex`: number): *Date*
+___
 
-*Defined in [utils.ts:12](https://github.com/jonstuebe/date-fns-holiday-us/blob/master/src/utils.ts#L12)*
+### getObservedHolidays
 
-**Parameters:**
+▸ **getObservedHolidays**(`year`): `Record`<`string`, `Record`<``"date"``, `Date`\>\>
 
-Name | Type |
------- | ------ |
-`date` | Date |
-`dayOfWeekIndex` | number |
+#### Parameters
 
-**Returns:** *Date*
+| Name | Type |
+| :------ | :------ |
+| `year` | `number` |
 
-___
+#### Returns
 
-###  getObservedHolidays
+`Record`<`string`, `Record`<``"date"``, `Date`\>\>
 
-▸ **getObservedHolidays**(`year`: number): *Record‹string, Record‹"date", Date››*
+#### Defined in
 
-*Defined in [index.ts:266](https://github.com/jonstuebe/date-fns-holiday-us/blob/master/src/index.ts#L266)*
+[index.ts:264](https://github.com/jonstuebe/date-fns-holiday-us/blob/master/src/index.ts#L264)
 
-**Parameters:**
+___
 
-Name | Type |
------- | ------ |
-`year` | number |
+### getPresidentsDay
 
-**Returns:** *Record‹string, Record‹"date", Date››*
+▸ **getPresidentsDay**(`year`): `Date`
 
-___
+#### Parameters
 
-###  getPresidentsDay
+| Name | Type |
+| :------ | :------ |
+| `year` | `number` |
 
-▸ **getPresidentsDay**(`year`: number): *Date*
+#### Returns
 
-*Defined in [index.ts:95](https://github.com/jonstuebe/date-fns-holiday-us/blob/master/src/index.ts#L95)*
+`Date`
 
-**Parameters:**
+#### Defined in
 
-Name | Type |
------- | ------ |
-`year` | number |
+[index.ts:95](https://github.com/jonstuebe/date-fns-holiday-us/blob/master/src/index.ts#L95)
 
-**Returns:** *Date*
-
 ___
 
-###  getPrevOccurence
+### getThanksgiving
 
-▸ **getPrevOccurence**(`date`: Date, `dayOfWeekIndex`: number): *Date*
+▸ **getThanksgiving**(`year`): `Date`
 
-*Defined in [utils.ts:25](https://github.com/jonstuebe/date-fns-holiday-us/blob/master/src/utils.ts#L25)*
+#### Parameters
 
-**Parameters:**
+| Name | Type |
+| :------ | :------ |
+| `year` | `number` |
 
-Name | Type |
------- | ------ |
-`date` | Date |
-`dayOfWeekIndex` | number |
+#### Returns
 
-**Returns:** *Date*
+`Date`
 
-___
+#### Defined in
 
-###  getThanksgiving
+[index.ts:111](https://github.com/jonstuebe/date-fns-holiday-us/blob/master/src/index.ts#L111)
 
-▸ **getThanksgiving**(`year`: number): *Date*
+___
 
-*Defined in [index.ts:111](https://github.com/jonstuebe/date-fns-holiday-us/blob/master/src/index.ts#L111)*
+### getValentinesDay
 
-**Parameters:**
+▸ **getValentinesDay**(`year`): `Date`
 
-Name | Type |
------- | ------ |
-`year` | number |
+#### Parameters
 
-**Returns:** *Date*
+| Name | Type |
+| :------ | :------ |
+| `year` | `number` |
 
-___
+#### Returns
 
-###  getValentinesDay
+`Date`
 
-▸ **getValentinesDay**(`year`: number): *Date*
+#### Defined in
 
-*Defined in [index.ts:37](https://github.com/jonstuebe/date-fns-holiday-us/blob/master/src/index.ts#L37)*
+[index.ts:37](https://github.com/jonstuebe/date-fns-holiday-us/blob/master/src/index.ts#L37)
 
-**Parameters:**
+___
 
-Name | Type |
------- | ------ |
-`year` | number |
+### getVeteransDay
 
-**Returns:** *Date*
+▸ **getVeteransDay**(`year`): `Date`
 
-___
+#### Parameters
 
-###  getVeteransDay
+| Name | Type |
+| :------ | :------ |
+| `year` | `number` |
 
-▸ **getVeteransDay**(`year`: number): *Date*
+#### Returns
 
-*Defined in [index.ts:107](https://github.com/jonstuebe/date-fns-holiday-us/blob/master/src/index.ts#L107)*
+`Date`
 
-**Parameters:**
+#### Defined in
 
-Name | Type |
------- | ------ |
-`year` | number |
+[index.ts:107](https://github.com/jonstuebe/date-fns-holiday-us/blob/master/src/index.ts#L107)
 
-**Returns:** *Date*
-
 ___
 
-###  isBankHoliday
+### isBankHoliday
 
-▸ **isBankHoliday**(`date`: Date): *boolean*
+▸ **isBankHoliday**(`date`): `boolean`
 
-*Defined in [index.ts:315](https://github.com/jonstuebe/date-fns-holiday-us/blob/master/src/index.ts#L315)*
+#### Parameters
 
-**Parameters:**
+| Name | Type |
+| :------ | :------ |
+| `date` | `Date` |
 
-Name | Type |
------- | ------ |
-`date` | Date |
+#### Returns
 
-**Returns:** *boolean*
+`boolean`
 
-___
+#### Defined in
 
-###  isHoliday
+[index.ts:313](https://github.com/jonstuebe/date-fns-holiday-us/blob/master/src/index.ts#L313)
 
-▸ **isHoliday**(`date`: Date): *boolean*
+___
 
-*Defined in [index.ts:311](https://github.com/jonstuebe/date-fns-holiday-us/blob/master/src/index.ts#L311)*
+### isHoliday
 
-**Parameters:**
+▸ **isHoliday**(`date`): `boolean`
 
-Name | Type |
------- | ------ |
-`date` | Date |
+#### Parameters
 
-**Returns:** *boolean*
+| Name | Type |
+| :------ | :------ |
+| `date` | `Date` |
 
-___
+#### Returns
 
-###  isInHolidayList
+`boolean`
 
-▸ **isInHolidayList**(`date`: Date, `getHolidayList`: function): *boolean*
+#### Defined in
 
-*Defined in [index.ts:299](https://github.com/jonstuebe/date-fns-holiday-us/blob/master/src/index.ts#L299)*
+[index.ts:309](https://github.com/jonstuebe/date-fns-holiday-us/blob/master/src/index.ts#L309)
 
-**Parameters:**
+___
 
-▪ **date**: *Date*
+### isInHolidayList
 
-▪ **getHolidayList**: *function*
+▸ **isInHolidayList**(`date`, `getHolidayList`): `boolean`
 
-▸ (`year`: number): *object*
+#### Parameters
 
-**Parameters:**
+| Name | Type |
+| :------ | :------ |
+| `date` | `Date` |
+| `getHolidayList` | (`year`: `number`) => { `[key: string]`: { `date`: `Date`  };  } |
 
-Name | Type |
------- | ------ |
-`year` | number |
+#### Returns
 
-* \[ **key**: *string*\]: object
+`boolean`
 
-* **date**: *Date*
+#### Defined in
 
-**Returns:** *boolean*
+[index.ts:297](https://github.com/jonstuebe/date-fns-holiday-us/blob/master/src/index.ts#L297)
 
 &copy; 2020 Jon Stuebe

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

Environment variable access

Supply chain risk

Package accesses environment variables, which may be a sign of credential stuffing or data theft.

Found 1 instance in 1 package

Minified code

Quality

This package contains minified code. This may be harmless in some cases where minified code is included in packaged libraries, however packages on npm should not minify code.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

98395

increased by16.16%

Lines of code

1032

increased by59.26%

Number of low quality alerts

1

decreased by-66.67%

Number of lines in readme file

554

increased by2.03%

Number of low supply chain risk alerts

1

decreased by-50%

Worsened metrics

Dev dependency count

19

increased by90%

Number of package files

11

decreased by-15.38%

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes