Added more docs

rob-blackbourn · Jul 9, 2023 · 8fcb5ca · 8fcb5ca
1 parent 02a1f07
commit 8fcb5ca
Show file tree

Hide file tree

Showing 15 changed files with 285 additions and 199 deletions.
diff --git a/docs/classes/Calendar.html b/docs/classes/Calendar.html
diff --git a/docs/classes/Duration.html b/docs/classes/Duration.html
diff --git a/docs/classes/HolidayCalendar.html b/docs/classes/HolidayCalendar.html
diff --git a/docs/classes/IANATimezone.html b/docs/classes/IANATimezone.html
diff --git a/docs/classes/LocaleInfo.html b/docs/classes/LocaleInfo.html
diff --git a/docs/classes/Timezone.html b/docs/classes/Timezone.html
diff --git a/docs/classes/WeekendCalendar.html b/docs/classes/WeekendCalendar.html
diff --git a/docs/enums/BusinessDayConvention.html b/docs/enums/BusinessDayConvention.html
diff --git a/docs/interfaces/DatePartResponse.html b/docs/interfaces/DatePartResponse.html
diff --git a/docs/interfaces/DayPlurals.html b/docs/interfaces/DayPlurals.html
diff --git a/docs/interfaces/I18nSettings.html b/docs/interfaces/I18nSettings.html
diff --git a/docs/interfaces/TimezoneOffset.html b/docs/interfaces/TimezoneOffset.html
diff --git a/docs/modules.html b/docs/modules.html
diff --git a/docs/pages/guide/calendars.html b/docs/pages/guide/calendars.html
diff --git a/manual/guide/calendars.md b/manual/guide/calendars.md
@@ -36,3 +36,78 @@ const cal = new HolidayCalendar(
   tzLocal
 )
 ```
+
+## Custom Calendars
+
+You can make your own calendars. The following abstract class provides a calendar
+which caches the holidays for a year.
+
+```ts
+import { WeekendCalendar, Timezone, startOfDay, tzLocal } from "@jetblack/date"; 
+
+export abstract class YearlyCalendar extends WeekendCalendar {
+
+    private holidays: Map<number, Map<number, string>> = new Map()
+
+    constructor (name: string, weekends: number[] = [0, 6]) {
+        super(name, weekends)
+    }
+
+    public override isHoliday(date: Date, tz: Timezone = tzLocal): boolean {
+        if (this.isWeekend(date, tz)) {
+            return true
+        }
+
+        const year = tz.year(date)
+        if (!this.holidays.has(year)) {
+            this.holidays.set(year, this.fetchHolidays(year, tz))
+        }
+
+        const yearHolidays = this.holidays.get(year)
+        return yearHolidays.has(startOfDay(date, tz).getTime())
+    }
+
+    protected abstract fetchHolidays(year: number, tz: Timezone): Map<number, string> 
+}
+```
+
+With the above we can create a rules based calendar.
+
+```ts
+import { Timezone, easter, addDays } from "@jetblack/date"
+import { YearlyCalendar } from "./YearlyCalendar"
+
+export class Target extends YearlyCalendar {
+    constructor() {
+        super("TARGET", [0, 6])
+    }
+
+    protected override fetchHolidays(year: number, tz: Timezone): Map<number, string> {
+        const holidays: Map<number, string> = new Map()
+
+        holidays.set(tz.makeDate(year, 0, 1).getTime(), "New Year's Day")
+
+        if (year >= 2000) {
+            const easterSunday = easter(year, tz)
+            holidays.set(addDays(easterSunday, -2, tz).getTime(), "Good Friday")
+            holidays.set(addDays(easterSunday, 1, tz).getTime(), "Easter Monday")
+        }
+
+        if (year >= 2000) {
+            holidays.set(tz.makeDate(year, 4, 1).getTime(), "Labor Day")
+        }
+
+        holidays.set(tz.makeDate(year, 11, 25).getTime(), "Christmas Day")
+
+        if (year >= 2000) {
+            holidays.set(tz.makeDate(year, 11, 26).getTime(), "Christmas Holiday")
+        }
+
+        if (year === 1998 || year === 1999 || year === 2001) {
+            holidays.set(tz.makeDate(year, 11, 31).getTime(), "New Year's Eve")
+        }
+
+        return holidays
+    }
+}
+```