colombian-holidays 5.0.0 → 5.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -5
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,7 +1,6 @@
|
|
|
1
1
|
# Colombian Holidays 🎆
|
|
2
2
|
|
|
3
3
|
[](https://badge.fury.io/js/colombian-holidays)
|
|
4
|
-
[](https://github.com/MauricioRobayo/colombian-holidays/actions/workflows/build-and-release.yml)
|
|
5
4
|
[](https://codecov.io/gh/MauricioRobayo/colombian-holidays)
|
|
6
5
|
[](https://www.codefactor.io/repository/github/mauriciorobayo/colombian-holidays)
|
|
7
6
|
[](git@github.com:MauricioRobayo/colombian-holidays.git)
|
|
@@ -264,7 +263,7 @@ The package provides four helper functions:
|
|
|
264
263
|
Returns the list of all Colombian holidays for a given year.
|
|
265
264
|
|
|
266
265
|
```js
|
|
267
|
-
import { getHolidaysByYear } from "colombian-holidays
|
|
266
|
+
import { getHolidaysByYear } from "colombian-holidays";
|
|
268
267
|
|
|
269
268
|
const holidays = getHolidaysByYear(2025);
|
|
270
269
|
```
|
|
@@ -290,7 +289,7 @@ This function uses a shared in-memory cache and is a preferable option to `colom
|
|
|
290
289
|
Returns `true` if the given date is a colombian holiday, otherwise returns `false`.
|
|
291
290
|
|
|
292
291
|
```js
|
|
293
|
-
import { isHoliday } from "colombian-holidays
|
|
292
|
+
import { isHoliday } from "colombian-holidays";
|
|
294
293
|
|
|
295
294
|
const date = new Date("2018-01-01");
|
|
296
295
|
|
|
@@ -306,7 +305,7 @@ if (isHoliday(date)) {
|
|
|
306
305
|
Similar to `isHoliday` but will return the corresponding holiday for a given date or `null` if there is no matching holiday.
|
|
307
306
|
|
|
308
307
|
```js
|
|
309
|
-
import { getHoliday } from "colombian-holidays
|
|
308
|
+
import { getHoliday } from "colombian-holidays";
|
|
310
309
|
|
|
311
310
|
const date = new Date("2018-01-01");
|
|
312
311
|
|
|
@@ -332,7 +331,7 @@ const newYearAsDate = getHoliday(date, { valueAsDate: true });
|
|
|
332
331
|
Returns an array with the colombian holidays within two dates:
|
|
333
332
|
|
|
334
333
|
```js
|
|
335
|
-
import { holidaysWithinInterval } from "colombian-holidays
|
|
334
|
+
import { holidaysWithinInterval } from "colombian-holidays";
|
|
336
335
|
|
|
337
336
|
const start = new Date("2021-01-01");
|
|
338
337
|
const end = new Date("2021-01-11");
|