MonthlyEvent
MONTHLY - Recurring events on the same day every month Supports intervals, month exclusions, and date exclusions.
Example
Section titled “Example”// Every 15th of the month{ type: "monthly", id: "payday", day: 15 }
// Quarterly (every 3 months starting January){ type: "monthly", id: "quarterly-review", day: 1, interval: 3, startMonth: 1 }
// Monthly except December{ type: "monthly", id: "team-lunch", day: 10, excludeMonths: [12] }Extends
Section titled “Extends”BaseEventProperties<TMetadata,TCategory>
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
Properties
Section titled “Properties”allDay?
Section titled “allDay?”
optionalallDay?:boolean
Inherited from
Section titled “Inherited from”categories?
Section titled “categories?”
optionalcategories?:TCategory[]
Inherited from
Section titled “Inherited from”BaseEventProperties.categories
color?
Section titled “color?”
optionalcolor?:string
Inherited from
Section titled “Inherited from”day:
number
Day of the month. 1–31, or negative to count from the end
(-1 = last day of every month, -2 = second-to-last).
Note: a positive day past the month’s length (e.g. 31 in February) is
skipped for that month.
Examples
Section titled “Examples”15 // 15th of each month-1 // last day of every monthdescription?
Section titled “description?”
optionaldescription?:string
Inherited from
Section titled “Inherited from”BaseEventProperties.description
duration?
Section titled “duration?”
optionalduration?:number
Inherited from
Section titled “Inherited from”endDate?
Section titled “endDate?”
optionalendDate?:string
Inherited from
Section titled “Inherited from”endTime?
Section titled “endTime?”
optionalendTime?:string
Inherited from
Section titled “Inherited from”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.
Inherited from
Section titled “Inherited from”BaseEventProperties.exceptions
excludeDates?
Section titled “excludeDates?”
optionalexcludeDates?:string[]
Specific dates to exclude (ISO format: YYYY-MM-DD)
Example
Section titled “Example”["2025-12-15"] // Skip this specific dateexcludeMonths?
Section titled “excludeMonths?”
optionalexcludeMonths?:number[]
Months to exclude (1-12)
Example
Section titled “Example”[7, 8] // Skip July and August
optionalicon?:string
Inherited from
Section titled “Inherited from”id:
string
Inherited from
Section titled “Inherited from”interval?
Section titled “interval?”
optionalinterval?:number
Recurrence interval in months (default: 1)
Example
Section titled “Example”3 // Every 3 months (quarterly)keywords?
Section titled “keywords?”
optionalkeywords?:string[]
Inherited from
Section titled “Inherited from”location?
Section titled “location?”
optionallocation?:string
Inherited from
Section titled “Inherited from”metadata?
Section titled “metadata?”
optionalmetadata?:TMetadata
Inherited from
Section titled “Inherited from”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
Inherited from
Section titled “Inherited from”BaseEventProperties.onConflict
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}Inherited from
Section titled “Inherited from”BaseEventProperties.overrideDates
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).
Inherited from
Section titled “Inherited from”reminders?
Section titled “reminders?”
optionalreminders?:Reminder[]
Inherited from
Section titled “Inherited from”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).
Inherited from
Section titled “Inherited from”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" }Inherited from
Section titled “Inherited from”startMonth?
Section titled “startMonth?”
optionalstartMonth?:number
Starting month for interval calculation (1-12, default: 1) Used with interval to determine which months the event occurs
Example
Section titled “Example”1 // Start counting from JanuarystartTime?
Section titled “startTime?”
optionalstartTime?:string
Inherited from
Section titled “Inherited from”status?
Section titled “status?”
optionalstatus?:"confirmed"|"tentative"|"cancelled"
Inherited from
Section titled “Inherited from”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-7Inherited from
Section titled “Inherited from”title:
string
Inherited from
Section titled “Inherited from”type:
"monthly"
optionalurl?:string