colombian-holidays 3.0.0 → 4.0.1
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 +3 -3
- package/lib/helpers.d.ts +3 -3
- package/lib/helpers.js +3 -5
- package/lib/helpers.js.map +1 -1
- package/lib/holidays.js +1 -1
- package/lib/index.d.ts +3 -3
- package/lib/index.js +2 -2
- package/lib/index.js.map +1 -1
- package/lib/utils/holidaysWithinInterval.d.ts +3 -3
- package/lib/utils/holidaysWithinInterval.js +2 -2
- package/lib/utils/holidaysWithinInterval.js.map +1 -1
- package/package.json +2 -7
package/README.md
CHANGED
@@ -218,12 +218,12 @@ Returns:
|
|
218
218
|
];
|
219
219
|
```
|
220
220
|
|
221
|
-
You can opt-in to have the function return native JavaScript dates instead of strings for the `date` and `celebrationDate` properties by using the `
|
221
|
+
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:
|
222
222
|
|
223
223
|
```js
|
224
224
|
const colombianHolidays2015 = colombianHolidays({
|
225
225
|
year: 2015,
|
226
|
-
|
226
|
+
valueAsDate: true,
|
227
227
|
});
|
228
228
|
```
|
229
229
|
|
@@ -232,7 +232,7 @@ If the year is omitted, by default the function will return the holidays for the
|
|
232
232
|
```js
|
233
233
|
const currentYearHolidaysAsStrings = colombianHolidays();
|
234
234
|
const currentYearHolidaysAsDates = colombianHolidays({
|
235
|
-
|
235
|
+
valueAsDate: true,
|
236
236
|
});
|
237
237
|
```
|
238
238
|
|
package/lib/helpers.d.ts
CHANGED
@@ -2,14 +2,14 @@ import type { Holiday, ColombianHoliday, ColombianHolidayWithNativeDate } from "
|
|
2
2
|
export declare const NEW_HOLIDAY_SCHEMA_START_YEAR = 1984;
|
3
3
|
declare function getHoliday(holiday: Holiday, options?: {
|
4
4
|
year?: number;
|
5
|
-
|
5
|
+
valueAsDate: false | undefined;
|
6
6
|
}): ColombianHoliday;
|
7
7
|
declare function getHoliday(holiday: Holiday, options: {
|
8
8
|
year?: number;
|
9
|
-
|
9
|
+
valueAsDate: true;
|
10
10
|
}): ColombianHolidayWithNativeDate;
|
11
11
|
declare function getHoliday(holiday: Holiday, options?: {
|
12
12
|
year?: number;
|
13
|
-
|
13
|
+
valueAsDate?: boolean;
|
14
14
|
}): ColombianHoliday | ColombianHolidayWithNativeDate;
|
15
15
|
export default getHoliday;
|
package/lib/helpers.js
CHANGED
@@ -35,16 +35,14 @@ function generateUtcStringFromDateParts(year, month, day) {
|
|
35
35
|
function generateUtcStringFromDate(date) {
|
36
36
|
return generateUtcStringFromDateParts(date.getUTCFullYear(), date.getUTCMonth() + 1, date.getUTCDate());
|
37
37
|
}
|
38
|
-
function getHoliday(holiday, { year = new Date().getUTCFullYear(),
|
38
|
+
function getHoliday(holiday, { year = new Date().getUTCFullYear(), valueAsDate = false, } = {}) {
|
39
39
|
const holidayDate = getHolidayDate(holiday, year);
|
40
40
|
const celebrationDate = year >= exports.NEW_HOLIDAY_SCHEMA_START_YEAR && holiday.nextMonday
|
41
41
|
? getNextMonday(holidayDate)
|
42
42
|
: holidayDate;
|
43
43
|
return {
|
44
|
-
date:
|
45
|
-
|
46
|
-
: generateUtcStringFromDate(holidayDate),
|
47
|
-
celebrationDate: returnNativeDate
|
44
|
+
date: valueAsDate ? holidayDate : generateUtcStringFromDate(holidayDate),
|
45
|
+
celebrationDate: valueAsDate
|
48
46
|
? celebrationDate
|
49
47
|
: generateUtcStringFromDate(celebrationDate),
|
50
48
|
name: holiday.name,
|
package/lib/helpers.js.map
CHANGED
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../src/helpers.ts"],"names":[],"mappings":";;;;;;AAAA,oDAA4B;AAQ5B,gEAAgE;AAChE,mEAAmE;AACtD,QAAA,6BAA6B,GAAG,IAAI,CAAC;AAElD,SAAS,gBAAgB,CAAC,IAAU,EAAE,SAAiB;IACrD,MAAM,UAAU,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC;IAClC,UAAU,CAAC,UAAU,CACnB,IAAI,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC,CAAC,GAAG,SAAS,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC,GAAG,CAAC,CAAC,CAC7D,CAAC;IACF,OAAO,UAAU,CAAC;AACpB,CAAC;AAED,SAAS,aAAa,CAAC,IAAU;IAC/B,MAAM,MAAM,GAAG,CAAC,CAAC;IACjB,OAAO,gBAAgB,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;AACxC,CAAC;AAED,SAAS,eAAe,CAAC,OAAgB;IACvC,OAAO,QAAQ,IAAI,OAAO,CAAC;AAC7B,CAAC;AAED,SAAS,cAAc,CAAC,OAAgB,EAAE,IAAY;IACpD,IAAI,eAAe,CAAC,OAAO,CAAC,EAAE;QAC5B,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,IAAA,gBAAM,EAAC,IAAI,CAAC,CAAC;QACpC,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,8BAA8B,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC;QACtE,IAAI,CAAC,UAAU,CAAC,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;QACtC,OAAO,IAAI,CAAC;KACb;IAED,OAAO,IAAI,IAAI,CACb,8BAA8B,CAAC,IAAI,EAAE,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC,CACjE,CAAC;AACJ,CAAC;AAED,SAAS,8BAA8B,CACrC,IAAY,EACZ,KAAa,EACb,GAAW;IAEX,OAAO,GAAG,IAAI,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,QAAQ,CACtE,CAAC,EACD,GAAG,CACJ,EAAE,CAAC;AACN,CAAC;AAED,SAAS,yBAAyB,CAAC,IAAU;IAC3C,OAAO,8BAA8B,CACnC,IAAI,CAAC,cAAc,EAAE,EACrB,IAAI,CAAC,WAAW,EAAE,GAAG,CAAC,EACtB,IAAI,CAAC,UAAU,EAAE,CAClB,CAAC;AACJ,CAAC;AAcD,SAAS,UAAU,CACjB,OAAgB,EAChB,EACE,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC,cAAc,EAAE,EAClC,
|
1
|
+
{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../src/helpers.ts"],"names":[],"mappings":";;;;;;AAAA,oDAA4B;AAQ5B,gEAAgE;AAChE,mEAAmE;AACtD,QAAA,6BAA6B,GAAG,IAAI,CAAC;AAElD,SAAS,gBAAgB,CAAC,IAAU,EAAE,SAAiB;IACrD,MAAM,UAAU,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC;IAClC,UAAU,CAAC,UAAU,CACnB,IAAI,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC,CAAC,GAAG,SAAS,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC,GAAG,CAAC,CAAC,CAC7D,CAAC;IACF,OAAO,UAAU,CAAC;AACpB,CAAC;AAED,SAAS,aAAa,CAAC,IAAU;IAC/B,MAAM,MAAM,GAAG,CAAC,CAAC;IACjB,OAAO,gBAAgB,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;AACxC,CAAC;AAED,SAAS,eAAe,CAAC,OAAgB;IACvC,OAAO,QAAQ,IAAI,OAAO,CAAC;AAC7B,CAAC;AAED,SAAS,cAAc,CAAC,OAAgB,EAAE,IAAY;IACpD,IAAI,eAAe,CAAC,OAAO,CAAC,EAAE;QAC5B,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,IAAA,gBAAM,EAAC,IAAI,CAAC,CAAC;QACpC,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,8BAA8B,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC;QACtE,IAAI,CAAC,UAAU,CAAC,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;QACtC,OAAO,IAAI,CAAC;KACb;IAED,OAAO,IAAI,IAAI,CACb,8BAA8B,CAAC,IAAI,EAAE,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC,CACjE,CAAC;AACJ,CAAC;AAED,SAAS,8BAA8B,CACrC,IAAY,EACZ,KAAa,EACb,GAAW;IAEX,OAAO,GAAG,IAAI,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,QAAQ,CACtE,CAAC,EACD,GAAG,CACJ,EAAE,CAAC;AACN,CAAC;AAED,SAAS,yBAAyB,CAAC,IAAU;IAC3C,OAAO,8BAA8B,CACnC,IAAI,CAAC,cAAc,EAAE,EACrB,IAAI,CAAC,WAAW,EAAE,GAAG,CAAC,EACtB,IAAI,CAAC,UAAU,EAAE,CAClB,CAAC;AACJ,CAAC;AAcD,SAAS,UAAU,CACjB,OAAgB,EAChB,EACE,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC,cAAc,EAAE,EAClC,WAAW,GAAG,KAAK,MACyB,EAAE;IAEhD,MAAM,WAAW,GAAG,cAAc,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IAClD,MAAM,eAAe,GACnB,IAAI,IAAI,qCAA6B,IAAI,OAAO,CAAC,UAAU;QACzD,CAAC,CAAC,aAAa,CAAC,WAAW,CAAC;QAC5B,CAAC,CAAC,WAAW,CAAC;IAElB,OAAO;QACL,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,yBAAyB,CAAC,WAAW,CAAC;QACxE,eAAe,EAAE,WAAW;YAC1B,CAAC,CAAC,eAAe;YACjB,CAAC,CAAC,yBAAyB,CAAC,eAAe,CAAC;QAC9C,IAAI,EAAE,OAAO,CAAC,IAAI;QAClB,UAAU,EAAE,IAAI,IAAI,qCAA6B,IAAI,OAAO,CAAC,UAAU;KACxE,CAAC;AACJ,CAAC;AAED,kBAAe,UAAU,CAAC"}
|
package/lib/holidays.js
CHANGED
package/lib/index.d.ts
CHANGED
@@ -6,16 +6,16 @@ export type Month = MonthNumbers | Omit<number, MonthNumbers>;
|
|
6
6
|
export declare function colombianHolidays(options?: undefined | {
|
7
7
|
year?: number;
|
8
8
|
month?: Month;
|
9
|
-
|
9
|
+
valueAsDate: false | undefined;
|
10
10
|
}): ColombianHoliday[];
|
11
11
|
export declare function colombianHolidays(options?: {
|
12
12
|
year?: number;
|
13
13
|
month?: Month;
|
14
|
-
|
14
|
+
valueAsDate: true;
|
15
15
|
}): ColombianHolidayWithNativeDate[];
|
16
16
|
export declare function colombianHolidays(options?: {
|
17
17
|
year?: number;
|
18
18
|
month?: Month;
|
19
|
-
|
19
|
+
valueAsDate?: boolean;
|
20
20
|
}): ColombianHoliday[] | ColombianHolidayWithNativeDate[];
|
21
21
|
export default colombianHolidays;
|
package/lib/index.js
CHANGED
@@ -9,12 +9,12 @@ const holidays_1 = __importDefault(require("./holidays"));
|
|
9
9
|
// pascua package year limits
|
10
10
|
exports.FIRST_HOLIDAY_YEAR = 1583;
|
11
11
|
exports.LAST_HOLIDAY_YEAR = 4099;
|
12
|
-
function colombianHolidays({ year = new Date().getUTCFullYear(), month,
|
12
|
+
function colombianHolidays({ year = new Date().getUTCFullYear(), month, valueAsDate = false, } = {}) {
|
13
13
|
if (year < exports.FIRST_HOLIDAY_YEAR || year > exports.LAST_HOLIDAY_YEAR) {
|
14
14
|
throw new Error(`The year should be between ${exports.FIRST_HOLIDAY_YEAR} and ${exports.LAST_HOLIDAY_YEAR}`);
|
15
15
|
}
|
16
16
|
return holidays_1.default
|
17
|
-
.map((holiday) => (0, helpers_1.default)(holiday, { year,
|
17
|
+
.map((holiday) => (0, helpers_1.default)(holiday, { year, valueAsDate }))
|
18
18
|
.filter((holiday) => {
|
19
19
|
if (month === undefined) {
|
20
20
|
return true;
|
package/lib/index.js.map
CHANGED
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;AAAA,wDAAmC;AACnC,0DAAkC;AAGlC,6BAA6B;AAChB,QAAA,kBAAkB,GAAG,IAAI,CAAC;AAC1B,QAAA,iBAAiB,GAAG,IAAI,CAAC;AAoBtC,SAAgB,iBAAiB,CAAC,EAChC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC,cAAc,EAAE,EAClC,KAAK,EACL,
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;AAAA,wDAAmC;AACnC,0DAAkC;AAGlC,6BAA6B;AAChB,QAAA,kBAAkB,GAAG,IAAI,CAAC;AAC1B,QAAA,iBAAiB,GAAG,IAAI,CAAC;AAoBtC,SAAgB,iBAAiB,CAAC,EAChC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC,cAAc,EAAE,EAClC,KAAK,EACL,WAAW,GAAG,KAAK,MAKjB,EAAE;IACJ,IAAI,IAAI,GAAG,0BAAkB,IAAI,IAAI,GAAG,yBAAiB,EAAE;QACzD,MAAM,IAAI,KAAK,CACb,8BAA8B,0BAAkB,QAAQ,yBAAiB,EAAE,CAC5E,CAAC;KACH;IAED,OAAO,kBAAQ;SACZ,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,IAAA,iBAAU,EAAC,OAAO,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,CAAC;SAC5D,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE;QAClB,IAAI,KAAK,KAAK,SAAS,EAAE;YACvB,OAAO,IAAI,CAAC;SACb;QAED,IAAI,OAAO,OAAO,CAAC,eAAe,KAAK,QAAQ,EAAE;YAC/C,OAAO,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC;SAC9D;QAED,OAAO,OAAO,CAAC,eAAe,CAAC,WAAW,EAAE,GAAG,CAAC,KAAK,KAAK,CAAC;IAC7D,CAAC,CAAC;SACD,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;QACb,IACE,CAAC,CAAC,eAAe,YAAY,IAAI;YACjC,CAAC,CAAC,eAAe,YAAY,IAAI,EACjC;YACA,OAAO,CAAC,CAAC,eAAe,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,eAAe,CAAC,OAAO,EAAE,CAAC;SAClE;QAED,IACE,OAAO,CAAC,CAAC,eAAe,KAAK,QAAQ;YACrC,OAAO,CAAC,CAAC,eAAe,KAAK,QAAQ,EACrC;YACA,OAAO,CAAC,CAAC,eAAe,CAAC,aAAa,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC;SAC3D;QAED,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;IACtE,CAAC,CAAC,CAAC;AACP,CAAC;AA7CD,8CA6CC;AAED,kBAAe,iBAAiB,CAAC"}
|
@@ -2,15 +2,15 @@ import { ColombianHoliday, ColombianHolidayWithNativeDate } from "../types";
|
|
2
2
|
export declare function holidaysWithinInterval(options: {
|
3
3
|
start: Date;
|
4
4
|
end: Date;
|
5
|
-
|
5
|
+
valueAsDate: false | undefined;
|
6
6
|
}): ColombianHoliday[];
|
7
7
|
export declare function holidaysWithinInterval(options: {
|
8
8
|
start: Date;
|
9
9
|
end: Date;
|
10
|
-
|
10
|
+
valueAsDate: true;
|
11
11
|
}): ColombianHolidayWithNativeDate[];
|
12
12
|
export declare function holidaysWithinInterval(options: {
|
13
13
|
start: Date;
|
14
14
|
end: Date;
|
15
|
-
|
15
|
+
valueAsDate?: boolean;
|
16
16
|
}): ColombianHoliday[] | ColombianHolidayWithNativeDate[];
|
@@ -5,13 +5,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
5
5
|
Object.defineProperty(exports, "__esModule", { value: true });
|
6
6
|
exports.holidaysWithinInterval = void 0;
|
7
7
|
const __1 = __importDefault(require(".."));
|
8
|
-
function holidaysWithinInterval({ start, end,
|
8
|
+
function holidaysWithinInterval({ start, end, valueAsDate = false, }) {
|
9
9
|
if (start >= end) {
|
10
10
|
throw new Error("end date should be greater than start date");
|
11
11
|
}
|
12
12
|
const yearEnd = end.getUTCFullYear();
|
13
13
|
const yearStart = start.getUTCFullYear();
|
14
|
-
const holidays = Array.from({ length: yearEnd - yearStart + 1 }, (_, i) => (0, __1.default)({ year: i + yearStart,
|
14
|
+
const holidays = Array.from({ length: yearEnd - yearStart + 1 }, (_, i) => (0, __1.default)({ year: i + yearStart, valueAsDate })).flat();
|
15
15
|
return holidays.filter(({ celebrationDate }) => {
|
16
16
|
const date = typeof celebrationDate === "string"
|
17
17
|
? new Date(celebrationDate)
|
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"file":"holidaysWithinInterval.js","sourceRoot":"","sources":["../../src/utils/holidaysWithinInterval.ts"],"names":[],"mappings":";;;;;;AAAA,2CAAmC;AAkBnC,SAAgB,sBAAsB,CAAC,EACrC,KAAK,EACL,GAAG,EACH,
|
1
|
+
{"version":3,"file":"holidaysWithinInterval.js","sourceRoot":"","sources":["../../src/utils/holidaysWithinInterval.ts"],"names":[],"mappings":";;;;;;AAAA,2CAAmC;AAkBnC,SAAgB,sBAAsB,CAAC,EACrC,KAAK,EACL,GAAG,EACH,WAAW,GAAG,KAAK,GAKpB;IACC,IAAI,KAAK,IAAI,GAAG,EAAE;QAChB,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;KAC/D;IACD,MAAM,OAAO,GAAG,GAAG,CAAC,cAAc,EAAE,CAAC;IACrC,MAAM,SAAS,GAAG,KAAK,CAAC,cAAc,EAAE,CAAC;IAEzC,MAAM,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,OAAO,GAAG,SAAS,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CACxE,IAAA,WAAiB,EAAC,EAAE,IAAI,EAAE,CAAC,GAAG,SAAS,EAAE,WAAW,EAAE,CAAC,CACxD,CAAC,IAAI,EAAE,CAAC;IAET,OAAO,QAAQ,CAAC,MAAM,CAAC,CAAC,EAAE,eAAe,EAAE,EAAE,EAAE;QAC7C,MAAM,IAAI,GACR,OAAO,eAAe,KAAK,QAAQ;YACjC,CAAC,CAAC,IAAI,IAAI,CAAC,eAAe,CAAC;YAC3B,CAAC,CAAC,eAAe,CAAC;QACtB,OAAO,IAAI,IAAI,KAAK,IAAI,IAAI,IAAI,GAAG,CAAC;IACtC,CAAC,CAAC,CAAC;AACL,CAAC;AA1BD,wDA0BC"}
|
package/package.json
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
{
|
2
2
|
"name": "colombian-holidays",
|
3
|
-
"version": "
|
3
|
+
"version": "4.0.1",
|
4
4
|
"description": "Colombian holidays",
|
5
5
|
"main": "lib/index.js",
|
6
6
|
"scripts": {
|
@@ -8,7 +8,7 @@
|
|
8
8
|
"lint": "eslint . --ext .ts --fix",
|
9
9
|
"test": "jest --coverage",
|
10
10
|
"build": "tsc",
|
11
|
-
"
|
11
|
+
"prepublishOnly": "tsc"
|
12
12
|
},
|
13
13
|
"license": "MIT",
|
14
14
|
"bugs": {
|
@@ -43,10 +43,5 @@
|
|
43
43
|
"repository": {
|
44
44
|
"type": "git",
|
45
45
|
"url": "https://github.com/MauricioRobayo/colombian-holidays.git"
|
46
|
-
},
|
47
|
-
"release": {
|
48
|
-
"branches": [
|
49
|
-
"main"
|
50
|
-
]
|
51
46
|
}
|
52
47
|
}
|