BaseEventProperties
Base properties shared by all event types (ICS-compatible)
Example
Section titled “Example”// Default usagetype Event = BaseEventProperties;
// With typed categoriestype LiturgicalCategory = "solemnity" | "feast" | "memorial";type LiturgicalEvent = BaseEventProperties<LiturgicalMetadata, LiturgicalCategory>;Extended by
Section titled “Extended by”ConstEventFixedEventFormulaEventRelativeEventNthWeekdayEventWeeklyEventMonthlyEventDailyEventCalendarEvent
Type Parameters
Section titled “Type Parameters”TMetadata
Section titled “TMetadata”TMetadata extends Record<string, unknown> = Record<string, unknown>
Custom metadata type extending Record<string, unknown>
TCategory
Section titled “TCategory”TCategory extends string = string
Category type (default: string, can be enum for type safety)
Properties
Section titled “Properties”allDay?
Section titled “allDay?”
optionalallDay?:boolean
categories?
Section titled “categories?”
optionalcategories?:TCategory[]
color?
Section titled “color?”
optionalcolor?:string
description?
Section titled “description?”
optionaldescription?:string
duration?
Section titled “duration?”
optionalduration?:number
endDate?
Section titled “endDate?”
optionalendDate?:string
endTime?
Section titled “endTime?”
optionalendTime?:string
exceptions?
Section titled “exceptions?”
optionalexceptions?:EventExceptions
Per-occurrence exceptions keyed by the event’s ORIGINAL computed date
(YYYY-MM-DD) — maps ICS EXDATE / RECURRENCE-ID. { skip: true } drops
that occurrence; { override } replaces properties for that one instance.
optionalicon?:string
id:
string
keywords?
Section titled “keywords?”
optionalkeywords?:string[]
location?
Section titled “location?”
optionallocation?:string
metadata?
Section titled “metadata?”
optionalmetadata?:TMetadata
onConflict?
Section titled “onConflict?”
optionalonConflict?:ConflictResolver
Conflict resolver for handling events on the same day. Called during event generation to determine action when this event would occur on a specific date.
Default behavior (when not specified): keep all events
overrideDates?
Section titled “overrideDates?”
optionaloverrideDates?:OverrideDatesMap
Force reschedule dates unconditionally. Unlike onConflict which handles conflicts, this always moves events. Key is the original computed date (YYYY-MM-DD), value is the new date.
Example
Section titled “Example”overrideDates: { "2026-02-18": "2026-02-20", // Move from Feb 18 to Feb 20}priority?
Section titled “priority?”
optionalpriority?:number
Display precedence when several events land on the same day, like CSS
z-index: higher = on top, default 0. The core only sorts by this
number (highest first); it assigns no meaning to the values — the consumer
does. Ties keep generation order (stable).
reminders?
Section titled “reminders?”
optionalreminders?:Reminder[]
source?
Section titled “source?”
optionalsource?:string
Origin of the event — the plugin, feed, or ICS subscription that produced it.
Lets a consumer customize/filter in bulk by source (like toggling a calendar
in Google/Apple Calendar) and namespaces the ICS export UID.
Distinct from groupId (a user-defined group) and sourceEventId (the
originating config id).
startDate?
Section titled “startDate?”
optionalstartDate?:string
Recurrence validity window (YYYY-MM-DD, both bounds inclusive).
Occurrences before startDate or after endDate are dropped — applied
centrally during generation, so it works for ANY event type (const, monthly,
weekly, nth-weekday, plugin types…), not just the few that ship their own
range fields.
Maps iCalendar semantics: startDate ↔ DTSTART lower bound, endDate ↔
RRULE;UNTIL (which RFC 5545 defines as inclusive). Both are DATE values
(all-day); recurrences are date-based, so no time component is involved.
Example
Section titled “Example”// Weekly stand-up, but only for July 2026{ type: "weekly", id: "standup", dayOfWeek: 1, startDate: "2026-07-01", endDate: "2026-07-31" }startTime?
Section titled “startTime?”
optionalstartTime?:string
status?
Section titled “status?”
optionalstatus?:"confirmed"|"tentative"|"cancelled"
templates?
Section titled “templates?”
optionaltemplates?:Record<string,string>
Per-occurrence dynamic fields, derived from each occurrence’s date. A map
of fieldName → template, where the template may contain date tokens
({YYYY} {MM} {DD} zero-padded · {M} {D} no padding). Each occurrence
gets the field set to the interpolated value.
Applied during generation, after the base value and before a
per-date exceptions[date].override (which always wins). Typically used for a
date-specific url, but any string field works (title, description,
location, …).
Example
Section titled “Example”// Every Sunday's link points at a date page{ type: "weekly", id: "mass", dayOfWeek: 0, title: "Mass", templates: { url: "https://x.com/mass/{D}-{M}" } }// 2026-07-07 → .../mass/7-7 · 2026-07-14 → .../mass/14-7title:
string
optionalurl?:string