From 0fa294ef3eaaedec96e7cac5d98895af56861cc4 Mon Sep 17 00:00:00 2001 From: Julian Maurer Date: Tue, 30 Sep 2025 18:33:50 +0200 Subject: [PATCH] Update deadline lib docs after release --- docs/deadlines/deadlines-library/README.md | 2 +- .../deadlines-library/documents/CHANGELOG.md | 9 +++++ .../index/classes/CalendarProvider.md | 26 +++++++------- .../index/classes/DeadlineCalculator.md | 12 +++---- .../index/enumerations/Bundesland.md | 34 +++++++++---------- .../index/enumerations/Commodity.md | 6 ++-- .../index/enumerations/HolidayType.md | 10 +++--- .../index/enumerations/UseCase.md | 6 ++-- .../index/functions/calculateDeadline.md | 2 +- .../index/functions/filterHolidaysForYear.md | 2 +- .../index/functions/findApplicableRule.md | 2 +- .../index/functions/getAllSpecialHolidays.md | 2 +- .../index/functions/getFixedHolidays.md | 2 +- .../index/functions/getMovingHolidays.md | 2 +- .../index/functions/getSpecialHolidays.md | 2 +- .../index/functions/getVersion.md | 2 +- .../index/functions/validateDate.md | 2 +- .../interfaces/CalendarProviderOptions.md | 6 ++-- .../index/interfaces/CalendarVersion.md | 8 ++--- .../index/interfaces/CustomHolidayConfig.md | 12 +++---- .../index/interfaces/DayInfo.md | 8 ++--- .../interfaces/DeadlineCalculatorOptions.md | 6 ++-- .../index/interfaces/DeadlineRule.md | 18 +++++----- .../index/interfaces/Holiday.md | 14 ++++---- .../index/interfaces/SwitchingCase.md | 8 ++--- .../index/variables/DEFAULT_DEADLINE_RULES.md | 2 +- 26 files changed, 107 insertions(+), 98 deletions(-) diff --git a/docs/deadlines/deadlines-library/README.md b/docs/deadlines/deadlines-library/README.md index 2efe5f9..2af6a43 100644 --- a/docs/deadlines/deadlines-library/README.md +++ b/docs/deadlines/deadlines-library/README.md @@ -89,7 +89,7 @@ Comprehensive documentation and background information are available in the 👉 This library is provided as an open-source contribution to the community to support flexibility when building custom systems around the epilot Energy XRM. It is not intended as a standalone product. Support is only provided for epilot customers. -If you are an active epilot contract, you can alternatively use our [Switching Deadlines REST API](https://docs.epilot.io/api/deadlines), which offers the same logic as a web service. +If you are an active epilot customer, you can alternatively use our [Switching Deadlines REST API](https://docs.epilot.io/api/deadlines), which offers the same logic as a web service. For questions or feedback regarding this library, please reach out to the epilot team. diff --git a/docs/deadlines/deadlines-library/documents/CHANGELOG.md b/docs/deadlines/deadlines-library/documents/CHANGELOG.md index 0f5f83a..edc5be0 100644 --- a/docs/deadlines/deadlines-library/documents/CHANGELOG.md +++ b/docs/deadlines/deadlines-library/documents/CHANGELOG.md @@ -3,3 +3,12 @@ *** [@epilot/switching-deadlines](../modules.md) / CHANGELOG + +# Changelog + +## [v2025.1.0] - 2025-09-30 + +Initial release 🎉 + +Full Changelog: +https://github.com/epilot-dev/switching-deadlines/commits/v2025.1.0 diff --git a/docs/deadlines/deadlines-library/index/classes/CalendarProvider.md b/docs/deadlines/deadlines-library/index/classes/CalendarProvider.md index 108c51b..679f742 100644 --- a/docs/deadlines/deadlines-library/index/classes/CalendarProvider.md +++ b/docs/deadlines/deadlines-library/index/classes/CalendarProvider.md @@ -6,7 +6,7 @@ # Class: CalendarProvider -Defined in: [calendar-provider.ts:68](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/calendar-provider.ts#L68) +Defined in: [calendar-provider.ts:68](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/calendar-provider.ts#L68) Calendar provider that manages holidays, working days, and date calculations. @@ -39,7 +39,7 @@ const nextWorking = calendar.getNextWorkingDay('2024-12-25'); > **new CalendarProvider**(`options?`): `CalendarProvider` -Defined in: [calendar-provider.ts:104](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/calendar-provider.ts#L104) +Defined in: [calendar-provider.ts:104](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/calendar-provider.ts#L104) Creates a new CalendarProvider instance. @@ -80,7 +80,7 @@ const provider = new CalendarProvider({ > **addWorkingDays**(`startDate`, `workingDays`): `Date` -Defined in: [calendar-provider.ts:295](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/calendar-provider.ts#L295) +Defined in: [calendar-provider.ts:295](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/calendar-provider.ts#L295) Adds a specified number of working days to a date, skipping weekends and holidays. @@ -121,7 +121,7 @@ const beforeHoliday = provider.addWorkingDays('2024-12-20', 3); // Skips Christm > **countWorkingDays**(`startDate`, `endDate`): `number` -Defined in: [calendar-provider.ts:404](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/calendar-provider.ts#L404) +Defined in: [calendar-provider.ts:404](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/calendar-provider.ts#L404) Counts the number of working days between two dates (inclusive). @@ -161,7 +161,7 @@ const projectDays = provider.countWorkingDays('2024-01-15', '2024-03-15'); > **getCalendarVersion**(): [`CalendarVersion`](../interfaces/CalendarVersion.md) -Defined in: [calendar-provider.ts:477](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/calendar-provider.ts#L477) +Defined in: [calendar-provider.ts:477](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/calendar-provider.ts#L477) Gets the current calendar version information. @@ -185,7 +185,7 @@ console.log(`Last updated: ${version.lastUpdated}`); > **getDayInfo**(`date`): [`DayInfo`](../interfaces/DayInfo.md) -Defined in: [calendar-provider.ts:252](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/calendar-provider.ts#L252) +Defined in: [calendar-provider.ts:252](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/calendar-provider.ts#L252) Gets detailed information about a specific day including working day status and holiday information. @@ -221,7 +221,7 @@ console.log(dayInfo); > **getNextWorkingDay**(`date`): `Date` -Defined in: [calendar-provider.ts:427](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/calendar-provider.ts#L427) +Defined in: [calendar-provider.ts:427](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/calendar-provider.ts#L427) Gets the next working day from a given date. @@ -256,7 +256,7 @@ const afterChristmas = provider.getNextWorkingDay('2024-12-25'); > **getNonWorkingDaysInRange**(`startDate`, `endDate`): [`DayInfo`](../interfaces/DayInfo.md)[] -Defined in: [calendar-provider.ts:368](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/calendar-provider.ts#L368) +Defined in: [calendar-provider.ts:368](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/calendar-provider.ts#L368) Gets all non-working days (weekends and holidays) between two dates (inclusive). @@ -299,7 +299,7 @@ nonWorkingDays.forEach(day => { > **getPreviousWorkingDay**(`date`): `Date` -Defined in: [calendar-provider.ts:454](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/calendar-provider.ts#L454) +Defined in: [calendar-provider.ts:454](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/calendar-provider.ts#L454) Gets the previous working day from a given date. @@ -334,7 +334,7 @@ const beforeNewYear = provider.getPreviousWorkingDay('2024-01-02'); > **getWorkingDaysInRange**(`startDate`, `endDate`): [`DayInfo`](../interfaces/DayInfo.md)[] -Defined in: [calendar-provider.ts:329](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/calendar-provider.ts#L329) +Defined in: [calendar-provider.ts:329](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/calendar-provider.ts#L329) Gets all working days between two dates (inclusive). @@ -375,7 +375,7 @@ workingDays.forEach(day => { > **isHoliday**(`date`): `false` \| [`Holiday`](../interfaces/Holiday.md) -Defined in: [calendar-provider.ts:195](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/calendar-provider.ts#L195) +Defined in: [calendar-provider.ts:195](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/calendar-provider.ts#L195) Checks if a specific date is a holiday. @@ -410,7 +410,7 @@ const dateHoliday = provider.isHoliday(new Date('2024-01-01')); > **isWorkingDay**(`date`): `boolean` -Defined in: [calendar-provider.ts:219](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/calendar-provider.ts#L219) +Defined in: [calendar-provider.ts:219](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/calendar-provider.ts#L219) Checks if a specific date is a working day (not a weekend or holiday). @@ -442,7 +442,7 @@ const isHoliday = provider.isWorkingDay('2024-12-25'); // false (Christmas) > **updateCustomHolidays**(`customHolidays`): `void` -Defined in: [calendar-provider.ts:504](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/calendar-provider.ts#L504) +Defined in: [calendar-provider.ts:504](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/calendar-provider.ts#L504) Updates the custom holidays configuration and clears the holiday cache. diff --git a/docs/deadlines/deadlines-library/index/classes/DeadlineCalculator.md b/docs/deadlines/deadlines-library/index/classes/DeadlineCalculator.md index cfbc4c0..e45828c 100644 --- a/docs/deadlines/deadlines-library/index/classes/DeadlineCalculator.md +++ b/docs/deadlines/deadlines-library/index/classes/DeadlineCalculator.md @@ -6,7 +6,7 @@ # Class: DeadlineCalculator -Defined in: [deadlines-calculator.ts:47](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/deadlines-calculator.ts#L47) +Defined in: [deadlines-calculator.ts:47](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/deadlines-calculator.ts#L47) Calculator for determining deadline dates and validating start dates for utility switching cases. @@ -35,7 +35,7 @@ console.log(result.earliestStartDate) > **new DeadlineCalculator**(`options?`): `DeadlineCalculator` -Defined in: [deadlines-calculator.ts:68](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/deadlines-calculator.ts#L68) +Defined in: [deadlines-calculator.ts:68](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/deadlines-calculator.ts#L68) Creates a new DeadlineCalculator instance. @@ -70,7 +70,7 @@ const calcCustom = new DeadlineCalculator({ > **calculateEarliestStartDate**(`switchingCase`, `fromDate?`): `object` -Defined in: [deadlines-calculator.ts:91](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/deadlines-calculator.ts#L91) +Defined in: [deadlines-calculator.ts:91](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/deadlines-calculator.ts#L91) Calculate the earliest possible start date for a contract @@ -142,7 +142,7 @@ When no applicable rule is found for the switching case > **getRule**(`switchingCase`): `undefined` \| [`DeadlineRule`](../interfaces/DeadlineRule.md) -Defined in: [deadlines-calculator.ts:220](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/deadlines-calculator.ts#L220) +Defined in: [deadlines-calculator.ts:220](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/deadlines-calculator.ts#L220) Get a specific rule for a switching case @@ -169,7 +169,7 @@ The matching deadline rule or undefined if none found > **getRules**(): [`DeadlineRule`](../interfaces/DeadlineRule.md)[] -Defined in: [deadlines-calculator.ts:204](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/deadlines-calculator.ts#L204) +Defined in: [deadlines-calculator.ts:204](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/deadlines-calculator.ts#L204) Get all configured rules @@ -188,7 +188,7 @@ Array of all configured deadline rules > **validateStartDate**(`switchingCase`, `proposedDate`, `fromDate?`): `object` -Defined in: [deadlines-calculator.ts:167](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/deadlines-calculator.ts#L167) +Defined in: [deadlines-calculator.ts:167](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/deadlines-calculator.ts#L167) Validate if a proposed start date is valid diff --git a/docs/deadlines/deadlines-library/index/enumerations/Bundesland.md b/docs/deadlines/deadlines-library/index/enumerations/Bundesland.md index 2218166..65da776 100644 --- a/docs/deadlines/deadlines-library/index/enumerations/Bundesland.md +++ b/docs/deadlines/deadlines-library/index/enumerations/Bundesland.md @@ -6,7 +6,7 @@ # Enumeration: Bundesland -Defined in: [holidays/types.ts:8](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/holidays/types.ts#L8) +Defined in: [holidays/types.ts:8](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/holidays/types.ts#L8) ## Enumeration Members @@ -14,7 +14,7 @@ Defined in: [holidays/types.ts:8](https://github.com/epilot-dev/switching-deadli > **BB**: `"Brandenburg"` -Defined in: [holidays/types.ts:12](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/holidays/types.ts#L12) +Defined in: [holidays/types.ts:12](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/holidays/types.ts#L12) *** @@ -22,7 +22,7 @@ Defined in: [holidays/types.ts:12](https://github.com/epilot-dev/switching-deadl > **BE**: `"Berlin"` -Defined in: [holidays/types.ts:11](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/holidays/types.ts#L11) +Defined in: [holidays/types.ts:11](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/holidays/types.ts#L11) *** @@ -30,7 +30,7 @@ Defined in: [holidays/types.ts:11](https://github.com/epilot-dev/switching-deadl > **BW**: `"Baden-Württemberg"` -Defined in: [holidays/types.ts:9](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/holidays/types.ts#L9) +Defined in: [holidays/types.ts:9](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/holidays/types.ts#L9) *** @@ -38,7 +38,7 @@ Defined in: [holidays/types.ts:9](https://github.com/epilot-dev/switching-deadli > **BY**: `"Bayern"` -Defined in: [holidays/types.ts:10](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/holidays/types.ts#L10) +Defined in: [holidays/types.ts:10](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/holidays/types.ts#L10) *** @@ -46,7 +46,7 @@ Defined in: [holidays/types.ts:10](https://github.com/epilot-dev/switching-deadl > **HB**: `"Bremen"` -Defined in: [holidays/types.ts:13](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/holidays/types.ts#L13) +Defined in: [holidays/types.ts:13](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/holidays/types.ts#L13) *** @@ -54,7 +54,7 @@ Defined in: [holidays/types.ts:13](https://github.com/epilot-dev/switching-deadl > **HE**: `"Hessen"` -Defined in: [holidays/types.ts:15](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/holidays/types.ts#L15) +Defined in: [holidays/types.ts:15](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/holidays/types.ts#L15) *** @@ -62,7 +62,7 @@ Defined in: [holidays/types.ts:15](https://github.com/epilot-dev/switching-deadl > **HH**: `"Hamburg"` -Defined in: [holidays/types.ts:14](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/holidays/types.ts#L14) +Defined in: [holidays/types.ts:14](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/holidays/types.ts#L14) *** @@ -70,7 +70,7 @@ Defined in: [holidays/types.ts:14](https://github.com/epilot-dev/switching-deadl > **MV**: `"Mecklenburg-Vorpommern"` -Defined in: [holidays/types.ts:16](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/holidays/types.ts#L16) +Defined in: [holidays/types.ts:16](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/holidays/types.ts#L16) *** @@ -78,7 +78,7 @@ Defined in: [holidays/types.ts:16](https://github.com/epilot-dev/switching-deadl > **NI**: `"Niedersachsen"` -Defined in: [holidays/types.ts:17](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/holidays/types.ts#L17) +Defined in: [holidays/types.ts:17](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/holidays/types.ts#L17) *** @@ -86,7 +86,7 @@ Defined in: [holidays/types.ts:17](https://github.com/epilot-dev/switching-deadl > **NW**: `"Nordrhein-Westfalen"` -Defined in: [holidays/types.ts:18](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/holidays/types.ts#L18) +Defined in: [holidays/types.ts:18](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/holidays/types.ts#L18) *** @@ -94,7 +94,7 @@ Defined in: [holidays/types.ts:18](https://github.com/epilot-dev/switching-deadl > **RP**: `"Rheinland-Pfalz"` -Defined in: [holidays/types.ts:19](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/holidays/types.ts#L19) +Defined in: [holidays/types.ts:19](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/holidays/types.ts#L19) *** @@ -102,7 +102,7 @@ Defined in: [holidays/types.ts:19](https://github.com/epilot-dev/switching-deadl > **SH**: `"Schleswig-Holstein"` -Defined in: [holidays/types.ts:23](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/holidays/types.ts#L23) +Defined in: [holidays/types.ts:23](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/holidays/types.ts#L23) *** @@ -110,7 +110,7 @@ Defined in: [holidays/types.ts:23](https://github.com/epilot-dev/switching-deadl > **SL**: `"Saarland"` -Defined in: [holidays/types.ts:20](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/holidays/types.ts#L20) +Defined in: [holidays/types.ts:20](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/holidays/types.ts#L20) *** @@ -118,7 +118,7 @@ Defined in: [holidays/types.ts:20](https://github.com/epilot-dev/switching-deadl > **SN**: `"Sachsen"` -Defined in: [holidays/types.ts:21](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/holidays/types.ts#L21) +Defined in: [holidays/types.ts:21](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/holidays/types.ts#L21) *** @@ -126,7 +126,7 @@ Defined in: [holidays/types.ts:21](https://github.com/epilot-dev/switching-deadl > **ST**: `"Sachsen-Anhalt"` -Defined in: [holidays/types.ts:22](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/holidays/types.ts#L22) +Defined in: [holidays/types.ts:22](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/holidays/types.ts#L22) *** @@ -134,4 +134,4 @@ Defined in: [holidays/types.ts:22](https://github.com/epilot-dev/switching-deadl > **TH**: `"Thüringen"` -Defined in: [holidays/types.ts:24](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/holidays/types.ts#L24) +Defined in: [holidays/types.ts:24](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/holidays/types.ts#L24) diff --git a/docs/deadlines/deadlines-library/index/enumerations/Commodity.md b/docs/deadlines/deadlines-library/index/enumerations/Commodity.md index a9f2b89..83dc884 100644 --- a/docs/deadlines/deadlines-library/index/enumerations/Commodity.md +++ b/docs/deadlines/deadlines-library/index/enumerations/Commodity.md @@ -6,7 +6,7 @@ # Enumeration: Commodity -Defined in: [rules/types.ts:1](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/rules/types.ts#L1) +Defined in: [rules/types.ts:1](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/rules/types.ts#L1) ## Enumeration Members @@ -14,7 +14,7 @@ Defined in: [rules/types.ts:1](https://github.com/epilot-dev/switching-deadlines > **GAS**: `"gas"` -Defined in: [rules/types.ts:3](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/rules/types.ts#L3) +Defined in: [rules/types.ts:3](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/rules/types.ts#L3) *** @@ -22,4 +22,4 @@ Defined in: [rules/types.ts:3](https://github.com/epilot-dev/switching-deadlines > **POWER**: `"power"` -Defined in: [rules/types.ts:2](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/rules/types.ts#L2) +Defined in: [rules/types.ts:2](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/rules/types.ts#L2) diff --git a/docs/deadlines/deadlines-library/index/enumerations/HolidayType.md b/docs/deadlines/deadlines-library/index/enumerations/HolidayType.md index e9fad0f..58c318d 100644 --- a/docs/deadlines/deadlines-library/index/enumerations/HolidayType.md +++ b/docs/deadlines/deadlines-library/index/enumerations/HolidayType.md @@ -6,7 +6,7 @@ # Enumeration: HolidayType -Defined in: [holidays/types.ts:1](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/holidays/types.ts#L1) +Defined in: [holidays/types.ts:1](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/holidays/types.ts#L1) ## Enumeration Members @@ -14,7 +14,7 @@ Defined in: [holidays/types.ts:1](https://github.com/epilot-dev/switching-deadli > **OPERATIONAL\_HOLIDAY**: `"operational_holiday"` -Defined in: [holidays/types.ts:4](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/holidays/types.ts#L4) +Defined in: [holidays/types.ts:4](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/holidays/types.ts#L4) *** @@ -22,7 +22,7 @@ Defined in: [holidays/types.ts:4](https://github.com/epilot-dev/switching-deadli > **PUBLIC\_HOLIDAY**: `"public_holiday"` -Defined in: [holidays/types.ts:3](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/holidays/types.ts#L3) +Defined in: [holidays/types.ts:3](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/holidays/types.ts#L3) *** @@ -30,7 +30,7 @@ Defined in: [holidays/types.ts:3](https://github.com/epilot-dev/switching-deadli > **SPECIAL\_HOLIDAY**: `"sonderfeiertag"` -Defined in: [holidays/types.ts:5](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/holidays/types.ts#L5) +Defined in: [holidays/types.ts:5](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/holidays/types.ts#L5) *** @@ -38,4 +38,4 @@ Defined in: [holidays/types.ts:5](https://github.com/epilot-dev/switching-deadli > **WEEKEND**: `"weekend"` -Defined in: [holidays/types.ts:2](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/holidays/types.ts#L2) +Defined in: [holidays/types.ts:2](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/holidays/types.ts#L2) diff --git a/docs/deadlines/deadlines-library/index/enumerations/UseCase.md b/docs/deadlines/deadlines-library/index/enumerations/UseCase.md index f8f2bf2..c1cc0de 100644 --- a/docs/deadlines/deadlines-library/index/enumerations/UseCase.md +++ b/docs/deadlines/deadlines-library/index/enumerations/UseCase.md @@ -6,7 +6,7 @@ # Enumeration: UseCase -Defined in: [rules/types.ts:6](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/rules/types.ts#L6) +Defined in: [rules/types.ts:6](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/rules/types.ts#L6) ## Enumeration Members @@ -14,7 +14,7 @@ Defined in: [rules/types.ts:6](https://github.com/epilot-dev/switching-deadlines > **RELOCATION**: `"relocation"` -Defined in: [rules/types.ts:7](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/rules/types.ts#L7) +Defined in: [rules/types.ts:7](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/rules/types.ts#L7) *** @@ -22,4 +22,4 @@ Defined in: [rules/types.ts:7](https://github.com/epilot-dev/switching-deadlines > **SWITCH**: `"switch"` -Defined in: [rules/types.ts:8](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/rules/types.ts#L8) +Defined in: [rules/types.ts:8](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/rules/types.ts#L8) diff --git a/docs/deadlines/deadlines-library/index/functions/calculateDeadline.md b/docs/deadlines/deadlines-library/index/functions/calculateDeadline.md index 5d52ad4..a6a8444 100644 --- a/docs/deadlines/deadlines-library/index/functions/calculateDeadline.md +++ b/docs/deadlines/deadlines-library/index/functions/calculateDeadline.md @@ -8,7 +8,7 @@ > **calculateDeadline**(`__namedParameters`, `fromDate?`): `Date` -Defined in: [helpers.ts:23](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/helpers.ts#L23) +Defined in: [helpers.ts:23](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/helpers.ts#L23) Calculate the earliest start date for a contract using default settings diff --git a/docs/deadlines/deadlines-library/index/functions/filterHolidaysForYear.md b/docs/deadlines/deadlines-library/index/functions/filterHolidaysForYear.md index a884f82..bf4ba84 100644 --- a/docs/deadlines/deadlines-library/index/functions/filterHolidaysForYear.md +++ b/docs/deadlines/deadlines-library/index/functions/filterHolidaysForYear.md @@ -8,7 +8,7 @@ > **filterHolidaysForYear**(`holidays`, `year`): [`Holiday`](../interfaces/Holiday.md)[] -Defined in: [holidays/utils.ts:3](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/holidays/utils.ts#L3) +Defined in: [holidays/utils.ts:3](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/holidays/utils.ts#L3) ## Parameters diff --git a/docs/deadlines/deadlines-library/index/functions/findApplicableRule.md b/docs/deadlines/deadlines-library/index/functions/findApplicableRule.md index 5e4316b..db64f47 100644 --- a/docs/deadlines/deadlines-library/index/functions/findApplicableRule.md +++ b/docs/deadlines/deadlines-library/index/functions/findApplicableRule.md @@ -8,7 +8,7 @@ > **findApplicableRule**(`commodity`, `useCase`, `requiresTermination`, `rules`): `undefined` \| [`DeadlineRule`](../interfaces/DeadlineRule.md) -Defined in: [rules/utils.ts:7](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/rules/utils.ts#L7) +Defined in: [rules/utils.ts:7](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/rules/utils.ts#L7) Get the applicable rule for a specific scenario diff --git a/docs/deadlines/deadlines-library/index/functions/getAllSpecialHolidays.md b/docs/deadlines/deadlines-library/index/functions/getAllSpecialHolidays.md index 36698c1..21f7798 100644 --- a/docs/deadlines/deadlines-library/index/functions/getAllSpecialHolidays.md +++ b/docs/deadlines/deadlines-library/index/functions/getAllSpecialHolidays.md @@ -8,7 +8,7 @@ > **getAllSpecialHolidays**(): [`Holiday`](../interfaces/Holiday.md)[] -Defined in: [holidays/special.ts:13](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/holidays/special.ts#L13) +Defined in: [holidays/special.ts:13](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/holidays/special.ts#L13) Default Sonderfeiertage that are legally mandated or officially declared. These are built into the library and don't need to be configured by consumers. diff --git a/docs/deadlines/deadlines-library/index/functions/getFixedHolidays.md b/docs/deadlines/deadlines-library/index/functions/getFixedHolidays.md index 945f147..24a617b 100644 --- a/docs/deadlines/deadlines-library/index/functions/getFixedHolidays.md +++ b/docs/deadlines/deadlines-library/index/functions/getFixedHolidays.md @@ -8,7 +8,7 @@ > **getFixedHolidays**(`year`): [`Holiday`](../interfaces/Holiday.md)[] -Defined in: [holidays/fixed.ts:9](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/holidays/fixed.ts#L9) +Defined in: [holidays/fixed.ts:9](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/holidays/fixed.ts#L9) Get all fixed-date holidays for a given year diff --git a/docs/deadlines/deadlines-library/index/functions/getMovingHolidays.md b/docs/deadlines/deadlines-library/index/functions/getMovingHolidays.md index 9dea3bb..ced5703 100644 --- a/docs/deadlines/deadlines-library/index/functions/getMovingHolidays.md +++ b/docs/deadlines/deadlines-library/index/functions/getMovingHolidays.md @@ -8,7 +8,7 @@ > **getMovingHolidays**(`year`): [`Holiday`](../interfaces/Holiday.md)[] -Defined in: [holidays/moving.ts:30](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/holidays/moving.ts#L30) +Defined in: [holidays/moving.ts:30](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/holidays/moving.ts#L30) Get all moving holidays (e.g. those based on Easter) for a given year diff --git a/docs/deadlines/deadlines-library/index/functions/getSpecialHolidays.md b/docs/deadlines/deadlines-library/index/functions/getSpecialHolidays.md index 64ecd67..04b693c 100644 --- a/docs/deadlines/deadlines-library/index/functions/getSpecialHolidays.md +++ b/docs/deadlines/deadlines-library/index/functions/getSpecialHolidays.md @@ -8,7 +8,7 @@ > **getSpecialHolidays**(`year`): [`Holiday`](../interfaces/Holiday.md)[] -Defined in: [holidays/special.ts:55](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/holidays/special.ts#L55) +Defined in: [holidays/special.ts:55](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/holidays/special.ts#L55) Filter Sonderfeiertage for a specific year diff --git a/docs/deadlines/deadlines-library/index/functions/getVersion.md b/docs/deadlines/deadlines-library/index/functions/getVersion.md index 07dc93e..a042513 100644 --- a/docs/deadlines/deadlines-library/index/functions/getVersion.md +++ b/docs/deadlines/deadlines-library/index/functions/getVersion.md @@ -8,7 +8,7 @@ > **getVersion**(): [`CalendarVersion`](../interfaces/CalendarVersion.md) -Defined in: [helpers.ts:80](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/helpers.ts#L80) +Defined in: [helpers.ts:80](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/helpers.ts#L80) Get the calendar version information diff --git a/docs/deadlines/deadlines-library/index/functions/validateDate.md b/docs/deadlines/deadlines-library/index/functions/validateDate.md index 1ffbab3..705aa25 100644 --- a/docs/deadlines/deadlines-library/index/functions/validateDate.md +++ b/docs/deadlines/deadlines-library/index/functions/validateDate.md @@ -8,7 +8,7 @@ > **validateDate**(`__namedParameters`, `proposedDate`, `fromDate?`): `boolean` -Defined in: [helpers.ts:52](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/helpers.ts#L52) +Defined in: [helpers.ts:52](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/helpers.ts#L52) Validate if a proposed start date is valid using default settings diff --git a/docs/deadlines/deadlines-library/index/interfaces/CalendarProviderOptions.md b/docs/deadlines/deadlines-library/index/interfaces/CalendarProviderOptions.md index adead2d..161c570 100644 --- a/docs/deadlines/deadlines-library/index/interfaces/CalendarProviderOptions.md +++ b/docs/deadlines/deadlines-library/index/interfaces/CalendarProviderOptions.md @@ -6,7 +6,7 @@ # Interface: CalendarProviderOptions -Defined in: [calendar-provider.ts:19](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/calendar-provider.ts#L19) +Defined in: [calendar-provider.ts:19](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/calendar-provider.ts#L19) Options for configuring a [CalendarProvider](../classes/CalendarProvider.md). @@ -16,7 +16,7 @@ Options for configuring a [CalendarProvider](../classes/CalendarProvider.md). > `optional` **customCalendar**: `object` -Defined in: [calendar-provider.ts:23](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/calendar-provider.ts#L23) +Defined in: [calendar-provider.ts:23](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/calendar-provider.ts#L23) Custom calendar configuration. @@ -38,7 +38,7 @@ Version information for the custom calendar. > `optional` **useSpecialHolidays**: `boolean` -Defined in: [calendar-provider.ts:40](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/calendar-provider.ts#L40) +Defined in: [calendar-provider.ts:40](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/calendar-provider.ts#L40) Whether to include special holidays from the library. diff --git a/docs/deadlines/deadlines-library/index/interfaces/CalendarVersion.md b/docs/deadlines/deadlines-library/index/interfaces/CalendarVersion.md index 954e91a..41c6573 100644 --- a/docs/deadlines/deadlines-library/index/interfaces/CalendarVersion.md +++ b/docs/deadlines/deadlines-library/index/interfaces/CalendarVersion.md @@ -6,7 +6,7 @@ # Interface: CalendarVersion -Defined in: [types.ts:11](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/types.ts#L11) +Defined in: [types.ts:11](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/types.ts#L11) Represents version information of the deadlines calendar. @@ -18,7 +18,7 @@ Represents version information of the deadlines calendar. > **lastUpdated**: `string` -Defined in: [types.ts:14](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/types.ts#L14) +Defined in: [types.ts:14](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/types.ts#L14) ISO 8601 timestamp of when this version was last modified @@ -28,7 +28,7 @@ ISO 8601 timestamp of when this version was last modified > **version**: `string` -Defined in: [types.ts:12](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/types.ts#L12) +Defined in: [types.ts:12](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/types.ts#L12) The semantic version identifier (e.g., "2025.1.4") @@ -38,6 +38,6 @@ The semantic version identifier (e.g., "2025.1.4") > **year**: `number` -Defined in: [types.ts:13](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/types.ts#L13) +Defined in: [types.ts:13](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/types.ts#L13) The calendar year this version applies to diff --git a/docs/deadlines/deadlines-library/index/interfaces/CustomHolidayConfig.md b/docs/deadlines/deadlines-library/index/interfaces/CustomHolidayConfig.md index 2800ccf..81e43d4 100644 --- a/docs/deadlines/deadlines-library/index/interfaces/CustomHolidayConfig.md +++ b/docs/deadlines/deadlines-library/index/interfaces/CustomHolidayConfig.md @@ -6,7 +6,7 @@ # Interface: CustomHolidayConfig -Defined in: [holidays/types.ts:43](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/holidays/types.ts#L43) +Defined in: [holidays/types.ts:43](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/holidays/types.ts#L43) ## Properties @@ -14,7 +14,7 @@ Defined in: [holidays/types.ts:43](https://github.com/epilot-dev/switching-deadl > `optional` **bundeslaender**: [`Bundesland`](../enumerations/Bundesland.md)[] -Defined in: [holidays/types.ts:47](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/holidays/types.ts#L47) +Defined in: [holidays/types.ts:47](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/holidays/types.ts#L47) *** @@ -22,7 +22,7 @@ Defined in: [holidays/types.ts:47](https://github.com/epilot-dev/switching-deadl > **date**: `string` -Defined in: [holidays/types.ts:44](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/holidays/types.ts#L44) +Defined in: [holidays/types.ts:44](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/holidays/types.ts#L44) *** @@ -30,7 +30,7 @@ Defined in: [holidays/types.ts:44](https://github.com/epilot-dev/switching-deadl > `optional` **description**: `string` -Defined in: [holidays/types.ts:48](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/holidays/types.ts#L48) +Defined in: [holidays/types.ts:48](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/holidays/types.ts#L48) *** @@ -38,7 +38,7 @@ Defined in: [holidays/types.ts:48](https://github.com/epilot-dev/switching-deadl > **name**: `string` -Defined in: [holidays/types.ts:45](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/holidays/types.ts#L45) +Defined in: [holidays/types.ts:45](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/holidays/types.ts#L45) *** @@ -46,4 +46,4 @@ Defined in: [holidays/types.ts:45](https://github.com/epilot-dev/switching-deadl > `optional` **type**: [`HolidayType`](../enumerations/HolidayType.md) -Defined in: [holidays/types.ts:46](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/holidays/types.ts#L46) +Defined in: [holidays/types.ts:46](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/holidays/types.ts#L46) diff --git a/docs/deadlines/deadlines-library/index/interfaces/DayInfo.md b/docs/deadlines/deadlines-library/index/interfaces/DayInfo.md index 18d502c..51edd16 100644 --- a/docs/deadlines/deadlines-library/index/interfaces/DayInfo.md +++ b/docs/deadlines/deadlines-library/index/interfaces/DayInfo.md @@ -6,7 +6,7 @@ # Interface: DayInfo -Defined in: [holidays/types.ts:36](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/holidays/types.ts#L36) +Defined in: [holidays/types.ts:36](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/holidays/types.ts#L36) ## Properties @@ -14,7 +14,7 @@ Defined in: [holidays/types.ts:36](https://github.com/epilot-dev/switching-deadl > **date**: `string` -Defined in: [holidays/types.ts:37](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/holidays/types.ts#L37) +Defined in: [holidays/types.ts:37](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/holidays/types.ts#L37) *** @@ -22,7 +22,7 @@ Defined in: [holidays/types.ts:37](https://github.com/epilot-dev/switching-deadl > `optional` **holiday**: [`Holiday`](Holiday.md) -Defined in: [holidays/types.ts:39](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/holidays/types.ts#L39) +Defined in: [holidays/types.ts:39](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/holidays/types.ts#L39) *** @@ -30,4 +30,4 @@ Defined in: [holidays/types.ts:39](https://github.com/epilot-dev/switching-deadl > **isWorkingDay**: `boolean` -Defined in: [holidays/types.ts:38](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/holidays/types.ts#L38) +Defined in: [holidays/types.ts:38](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/holidays/types.ts#L38) diff --git a/docs/deadlines/deadlines-library/index/interfaces/DeadlineCalculatorOptions.md b/docs/deadlines/deadlines-library/index/interfaces/DeadlineCalculatorOptions.md index 5e67b62..73bb284 100644 --- a/docs/deadlines/deadlines-library/index/interfaces/DeadlineCalculatorOptions.md +++ b/docs/deadlines/deadlines-library/index/interfaces/DeadlineCalculatorOptions.md @@ -6,7 +6,7 @@ # Interface: DeadlineCalculatorOptions -Defined in: [deadlines-calculator.ts:14](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/deadlines-calculator.ts#L14) +Defined in: [deadlines-calculator.ts:14](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/deadlines-calculator.ts#L14) Options for configuring a [DeadlineCalculator](../classes/DeadlineCalculator.md). @@ -16,7 +16,7 @@ Options for configuring a [DeadlineCalculator](../classes/DeadlineCalculator.md) > `optional` **calendarProvider**: [`CalendarProvider`](../classes/CalendarProvider.md) -Defined in: [deadlines-calculator.ts:18](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/deadlines-calculator.ts#L18) +Defined in: [deadlines-calculator.ts:18](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/deadlines-calculator.ts#L18) Custom holiday calendar provider used for working day calculations. @@ -26,6 +26,6 @@ Custom holiday calendar provider used for working day calculations. > `optional` **customRules**: [`DeadlineRule`](DeadlineRule.md)[] -Defined in: [deadlines-calculator.ts:23](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/deadlines-calculator.ts#L23) +Defined in: [deadlines-calculator.ts:23](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/deadlines-calculator.ts#L23) Override default deadline rules with custom business logic. diff --git a/docs/deadlines/deadlines-library/index/interfaces/DeadlineRule.md b/docs/deadlines/deadlines-library/index/interfaces/DeadlineRule.md index 9b53163..35030b2 100644 --- a/docs/deadlines/deadlines-library/index/interfaces/DeadlineRule.md +++ b/docs/deadlines/deadlines-library/index/interfaces/DeadlineRule.md @@ -6,7 +6,7 @@ # Interface: DeadlineRule -Defined in: [rules/types.ts:11](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/rules/types.ts#L11) +Defined in: [rules/types.ts:11](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/rules/types.ts#L11) ## Properties @@ -14,7 +14,7 @@ Defined in: [rules/types.ts:11](https://github.com/epilot-dev/switching-deadline > **allowsRetrospective**: `boolean` -Defined in: [rules/types.ts:28](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/rules/types.ts#L28) +Defined in: [rules/types.ts:28](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/rules/types.ts#L28) Whether retrospective switching is allowed @@ -24,7 +24,7 @@ Whether retrospective switching is allowed > **commodity**: [`Commodity`](../enumerations/Commodity.md) -Defined in: [rules/types.ts:16](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/rules/types.ts#L16) +Defined in: [rules/types.ts:16](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/rules/types.ts#L16) The commodity this rule applies to @@ -34,7 +34,7 @@ The commodity this rule applies to > **description**: `string` -Defined in: [rules/types.ts:34](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/rules/types.ts#L34) +Defined in: [rules/types.ts:34](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/rules/types.ts#L34) Description of the rule @@ -44,7 +44,7 @@ Description of the rule > **id**: `string` -Defined in: [rules/types.ts:13](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/rules/types.ts#L13) +Defined in: [rules/types.ts:13](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/rules/types.ts#L13) Unique identifier for the rule @@ -54,7 +54,7 @@ Unique identifier for the rule > `optional` **maxRetrospectiveDays**: `number` -Defined in: [rules/types.ts:31](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/rules/types.ts#L31) +Defined in: [rules/types.ts:31](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/rules/types.ts#L31) Maximum retrospective period in days @@ -64,7 +64,7 @@ Maximum retrospective period in days > **requiredWorkingDays**: `number` -Defined in: [rules/types.ts:25](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/rules/types.ts#L25) +Defined in: [rules/types.ts:25](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/rules/types.ts#L25) Required working days lead time @@ -74,7 +74,7 @@ Required working days lead time > **requiresTermination**: `boolean` -Defined in: [rules/types.ts:22](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/rules/types.ts#L22) +Defined in: [rules/types.ts:22](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/rules/types.ts#L22) Whether this rule is for cases requiring termination @@ -84,6 +84,6 @@ Whether this rule is for cases requiring termination > **useCase**: [`UseCase`](../enumerations/UseCase.md) -Defined in: [rules/types.ts:19](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/rules/types.ts#L19) +Defined in: [rules/types.ts:19](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/rules/types.ts#L19) The use case this rule applies to diff --git a/docs/deadlines/deadlines-library/index/interfaces/Holiday.md b/docs/deadlines/deadlines-library/index/interfaces/Holiday.md index 5d0c9d9..25f1e8b 100644 --- a/docs/deadlines/deadlines-library/index/interfaces/Holiday.md +++ b/docs/deadlines/deadlines-library/index/interfaces/Holiday.md @@ -6,7 +6,7 @@ # Interface: Holiday -Defined in: [holidays/types.ts:27](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/holidays/types.ts#L27) +Defined in: [holidays/types.ts:27](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/holidays/types.ts#L27) ## Properties @@ -14,7 +14,7 @@ Defined in: [holidays/types.ts:27](https://github.com/epilot-dev/switching-deadl > `optional` **bundeslaender**: [`Bundesland`](../enumerations/Bundesland.md)[] -Defined in: [holidays/types.ts:31](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/holidays/types.ts#L31) +Defined in: [holidays/types.ts:31](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/holidays/types.ts#L31) *** @@ -22,7 +22,7 @@ Defined in: [holidays/types.ts:31](https://github.com/epilot-dev/switching-deadl > **date**: `string` -Defined in: [holidays/types.ts:28](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/holidays/types.ts#L28) +Defined in: [holidays/types.ts:28](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/holidays/types.ts#L28) *** @@ -30,7 +30,7 @@ Defined in: [holidays/types.ts:28](https://github.com/epilot-dev/switching-deadl > `optional` **description**: `string` -Defined in: [holidays/types.ts:32](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/holidays/types.ts#L32) +Defined in: [holidays/types.ts:32](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/holidays/types.ts#L32) *** @@ -38,7 +38,7 @@ Defined in: [holidays/types.ts:32](https://github.com/epilot-dev/switching-deadl > `optional` **isOneTime**: `boolean` -Defined in: [holidays/types.ts:33](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/holidays/types.ts#L33) +Defined in: [holidays/types.ts:33](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/holidays/types.ts#L33) *** @@ -46,7 +46,7 @@ Defined in: [holidays/types.ts:33](https://github.com/epilot-dev/switching-deadl > **name**: `string` -Defined in: [holidays/types.ts:29](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/holidays/types.ts#L29) +Defined in: [holidays/types.ts:29](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/holidays/types.ts#L29) *** @@ -54,4 +54,4 @@ Defined in: [holidays/types.ts:29](https://github.com/epilot-dev/switching-deadl > **type**: [`HolidayType`](../enumerations/HolidayType.md) -Defined in: [holidays/types.ts:30](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/holidays/types.ts#L30) +Defined in: [holidays/types.ts:30](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/holidays/types.ts#L30) diff --git a/docs/deadlines/deadlines-library/index/interfaces/SwitchingCase.md b/docs/deadlines/deadlines-library/index/interfaces/SwitchingCase.md index 19883c5..2422501 100644 --- a/docs/deadlines/deadlines-library/index/interfaces/SwitchingCase.md +++ b/docs/deadlines/deadlines-library/index/interfaces/SwitchingCase.md @@ -6,7 +6,7 @@ # Interface: SwitchingCase -Defined in: [types.ts:25](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/types.ts#L25) +Defined in: [types.ts:25](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/types.ts#L25) Represents a switching case configuration. @@ -18,7 +18,7 @@ Represents a switching case configuration. > **commodity**: [`Commodity`](../enumerations/Commodity.md) -Defined in: [types.ts:26](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/types.ts#L26) +Defined in: [types.ts:26](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/types.ts#L26) The commodity type (power or gas) @@ -28,7 +28,7 @@ The commodity type (power or gas) > **requiresTermination**: `boolean` -Defined in: [types.ts:28](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/types.ts#L28) +Defined in: [types.ts:28](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/types.ts#L28) Whether termination of the previous contract is required @@ -38,6 +38,6 @@ Whether termination of the previous contract is required > **useCase**: [`UseCase`](../enumerations/UseCase.md) -Defined in: [types.ts:27](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/types.ts#L27) +Defined in: [types.ts:27](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/types.ts#L27) The use case (relocation or supplier switch) diff --git a/docs/deadlines/deadlines-library/index/variables/DEFAULT_DEADLINE_RULES.md b/docs/deadlines/deadlines-library/index/variables/DEFAULT_DEADLINE_RULES.md index a5a3fca..99933ce 100644 --- a/docs/deadlines/deadlines-library/index/variables/DEFAULT_DEADLINE_RULES.md +++ b/docs/deadlines/deadlines-library/index/variables/DEFAULT_DEADLINE_RULES.md @@ -8,6 +8,6 @@ > `const` **DEFAULT\_DEADLINE\_RULES**: [`DeadlineRule`](../interfaces/DeadlineRule.md)[] -Defined in: [rules/index.ts:11](https://github.com/epilot-dev/switching-deadlines/blob/3e728b5f762c5b978f43c05453d07a8b73878933/src/rules/index.ts#L11) +Defined in: [rules/index.ts:11](https://github.com/epilot-dev/switching-deadlines/blob/399b2cc39d63ef20d5c31e06d92ee448511e691c/src/rules/index.ts#L11) Default deadline rules based on GPKE and GeLi Gas regulations