Skip to content

DailyEvent

DAILY - Recurring events every day, or every N days. Supports an interval, a date range, and date exclusions. With interval > 1 the cadence is phased off startDate (or a fixed epoch when omitted) so “every N days” stays in step across the year boundary instead of resetting.

// Every day
{ type: "daily", id: "standup" }
// Every 3 days, anchored to a start date
{ type: "daily", id: "meds", interval: 3, startDate: "2025-01-01" }

TMetadata extends Record<string, unknown> = Record<string, unknown>

Custom metadata type extending Record<string, unknown>

TCategory extends string = string

optional allDay?: boolean

BaseEventProperties.allDay


optional categories?: TCategory[]

BaseEventProperties.categories


optional color?: string

BaseEventProperties.color


optional description?: string

BaseEventProperties.description


optional duration?: number

BaseEventProperties.duration


optional endDate?: string

End date for the recurrence (YYYY-MM-DD, inclusive).

"2025-12-31"

BaseEventProperties.endDate


optional endTime?: string

BaseEventProperties.endTime


optional exceptions?: 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.

BaseEventProperties.exceptions


optional excludeDates?: string[]

Specific dates to exclude (YYYY-MM-DD).

["2025-12-25"]

optional icon?: string

BaseEventProperties.icon


id: string

BaseEventProperties.id


optional interval?: number

Recurrence interval in days (default: 1).

3 // every third day

optional keywords?: string[]

BaseEventProperties.keywords


optional location?: string

BaseEventProperties.location


optional metadata?: TMetadata

BaseEventProperties.metadata


optional onConflict?: 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

BaseEventProperties.onConflict


optional overrideDates?: 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.

overrideDates: {
"2026-02-18": "2026-02-20", // Move from Feb 18 to Feb 20
}

BaseEventProperties.overrideDates


optional priority?: 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).

BaseEventProperties.priority


optional reminders?: Reminder[]

BaseEventProperties.reminders


optional source?: 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).

BaseEventProperties.source


optional startDate?: string

Anchor date for interval phasing and the lower bound (YYYY-MM-DD). With interval > 1, occurrences land on startDate, startDate + interval, …

"2025-01-06"

BaseEventProperties.startDate


optional startTime?: string

BaseEventProperties.startTime


optional status?: "confirmed" | "tentative" | "cancelled"

BaseEventProperties.status


optional templates?: 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, …).

// 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-7

BaseEventProperties.templates


title: string

BaseEventProperties.title


type: "daily"


optional url?: string

BaseEventProperties.url