colombian-holidays 4.1.0 → 4.2.0

package/README.md

@@ -1,9 +1,10 @@
 # Colombian Holidays 🎆
 
 [![npm version](https://badge.fury.io/js/colombian-holidays.svg)](https://badge.fury.io/js/colombian-holidays)
-[![build and release](https://github.com/MauricioRobayo/colombian-holidays/actions/workflows/build-and-release.yml/badge.svg)](https://github.com/MauricioRobayo/colombian-holidays/actions/workflows/build-and-release.yml)
+[![Build and release](https://github.com/MauricioRobayo/colombian-holidays/actions/workflows/build-and-release.yml/badge.svg)](https://github.com/MauricioRobayo/colombian-holidays/actions/workflows/build-and-release.yml)
 [![codecov](https://codecov.io/gh/MauricioRobayo/colombian-holidays/branch/master/graph/badge.svg)](https://codecov.io/gh/MauricioRobayo/colombian-holidays)
 [![CodeFactor](https://www.codefactor.io/repository/github/mauriciorobayo/colombian-holidays/badge)](https://www.codefactor.io/repository/github/mauriciorobayo/colombian-holidays)
+[![](https://badgen.net/badge/Run%20with%20/VS%20Code/5B3ADF?icon=https://runme.dev/img/logo.svg)](git@github.com:MauricioRobayo/colombian-holidays.git)
 
 TypeScript module to calculate colombian holidays for any given year.
 
@@ -11,7 +12,7 @@ TypeScript module to calculate colombian holidays for any given year.
 
 To install as a dependency of your project:
 
-```shell
+```sh
 npm install colombian-holidays
 ```
 
@@ -39,6 +40,20 @@ You get a function that you can use to get the complete list of holidays for a g
 const colombianHolidays2015 = colombianHolidays({ year: 2015 });
 ```
 
+# Examples
+
+Get current year holidays
+
+```sh
+npm run ts-node examples/currentDate
+```
+
+Get next year holidays
+
+```sh
+npm run ts-node examples/nextYear
+```
+
 The content of the `colombianHolidays2015` variable will be the following array:
 
 ```js
@@ -218,6 +233,12 @@ Returns:
 ];
 ```
 
+Run the previous example
+
+```sh
+npm run ts-node examples/monthHolidays
+```
+
 You can opt-in to have the function return native JavaScript dates instead of strings for the `date` and `celebrationDate` properties by using the `valueAsDate` option:
 
 ```js

package/{lib → dist}/utils/getHoliday.d.ts

@@ -1,7 +1,7 @@
 import { ColombianHoliday, ColombianHolidayWithNativeDate } from "../types";
 export declare function getHoliday(date: Date, options: {
     valueAsDate: true;
-}): ColombianHolidayWithNativeDate;
+}): ColombianHolidayWithNativeDate | null;
 export declare function getHoliday(date: Date, options?: undefined | {
     valueAsDate: false;
-}): ColombianHoliday;
+}): ColombianHoliday | null;

package/dist/utils/isHoliday.js

@@ -0,0 +1,24 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isHoliday = void 0;
+const __1 = __importDefault(require(".."));
+const helpers_1 = require("./helpers");
+const holidaysCache = new Map();
+function isHoliday(date) {
+    const year = date.getUTCFullYear();
+    const cachedHolidays = holidaysCache.get(year);
+    if (cachedHolidays) {
+        return cachedHolidays.some(({ celebrationDate }) => (0, helpers_1.isSameDate)(celebrationDate, date));
+    }
+    const holidays = (0, __1.default)({
+        year,
+        valueAsDate: true,
+    });
+    holidaysCache.set(year, holidays);
+    return holidays.some(({ celebrationDate }) => (0, helpers_1.isSameDate)(celebrationDate, date));
+}
+exports.isHoliday = isHoliday;
+//# sourceMappingURL=isHoliday.js.map

package/dist/utils/isHoliday.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"isHoliday.js","sourceRoot":"","sources":["../../src/utils/isHoliday.ts"],"names":[],"mappings":";;;;;;AAAA,2CAAmC;AAEnC,uCAAuC;AAEvC,MAAM,aAAa,GAAG,IAAI,GAAG,EAA4C,CAAC;AAE1E,SAAgB,SAAS,CAAC,IAAU;IAClC,MAAM,IAAI,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;IACnC,MAAM,cAAc,GAAG,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAC/C,IAAI,cAAc,EAAE;QAClB,OAAO,cAAc,CAAC,IAAI,CAAC,CAAC,EAAE,eAAe,EAAE,EAAE,EAAE,CACjD,IAAA,oBAAU,EAAC,eAAe,EAAE,IAAI,CAAC,CAClC,CAAC;KACH;IACD,MAAM,QAAQ,GAAG,IAAA,WAAiB,EAAC;QACjC,IAAI;QACJ,WAAW,EAAE,IAAI;KAClB,CAAC,CAAC;IACH,aAAa,CAAC,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IAClC,OAAO,QAAQ,CAAC,IAAI,CAAC,CAAC,EAAE,eAAe,EAAE,EAAE,EAAE,CAC3C,IAAA,oBAAU,EAAC,eAAe,EAAE,IAAI,CAAC,CAClC,CAAC;AACJ,CAAC;AAhBD,8BAgBC"}

package/package.json

@@ -1,14 +1,15 @@
 {
   "name": "colombian-holidays",
-  "version": "4.1.0",
+  "version": "4.2.0",
   "description": "Colombian holidays",
-  "main": "lib/index.js",
+  "main": "dist/index.js",
   "scripts": {
     "format": "prettier --write .",
     "lint": "eslint . --ext .ts --fix",
     "test": "jest --coverage",
     "build": "tsc",
-    "prepublishOnly": "tsc"
+    "prepublishOnly": "tsc",
+    "ts-node": "ts-node"
   },
   "license": "MIT",
   "bugs": {
@@ -32,16 +33,20 @@
     "prettier": "^2.6.2",
     "timezone-mock": "^1.3.1",
     "ts-jest": "^27.1.4",
+    "ts-node": "^10.9.1",
     "typescript": "^4.6.4"
   },
   "dependencies": {
     "pascua": "^2.1.5"
   },
   "files": [
-    "lib"
+    "dist"
   ],
   "repository": {
     "type": "git",
     "url": "https://github.com/MauricioRobayo/colombian-holidays.git"
+  },
+  "release": {
+    "branches": "main"
   }
 }

package/lib/utils/isHoliday.js

@@ -1,16 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isHoliday = void 0;
-const __1 = __importDefault(require(".."));
-const helpers_1 = require("./helpers");
-function isHoliday(date) {
-    return (0, __1.default)({
-        year: date.getUTCFullYear(),
-        valueAsDate: true,
-    }).some(({ celebrationDate }) => (0, helpers_1.isSameDate)(celebrationDate, date));
-}
-exports.isHoliday = isHoliday;
-//# sourceMappingURL=isHoliday.js.map

package/lib/utils/isHoliday.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"isHoliday.js","sourceRoot":"","sources":["../../src/utils/isHoliday.ts"],"names":[],"mappings":";;;;;;AAAA,2CAAmC;AACnC,uCAAuC;AAEvC,SAAgB,SAAS,CAAC,IAAU;IAClC,OAAO,IAAA,WAAiB,EAAC;QACvB,IAAI,EAAE,IAAI,CAAC,cAAc,EAAE;QAC3B,WAAW,EAAE,IAAI;KAClB,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,eAAe,EAAE,EAAE,EAAE,CAAC,IAAA,oBAAU,EAAC,eAAe,EAAE,IAAI,CAAC,CAAC,CAAC;AACtE,CAAC;AALD,8BAKC"}