WeeklyEvent

WEEKLY - Recurring events on one or more days every week Supports multiple weekdays, intervals, date range, and date exclusions.

Example

// Every Monday
{ type: "weekly", id: "standup", dayOfWeek: 1 }

// Every Monday, Wednesday & Friday (like an alarm's "Repeat")
{ type: "weekly", id: "logwork", dayOfWeek: [1, 3, 5] }

// Every other Wednesday
{ type: "weekly", id: "biweekly-sync",
  dayOfWeek: 3, interval: 2 }

// Every Friday with date range
{ type: "weekly", id: "sprint-review",
  dayOfWeek: 5, startDate: "2025-01-01", endDate: "2025-12-31" }

Extends

• BaseEventProperties<TMetadata, TCategory>

Type Parameters

TMetadata

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

Custom metadata type extending Record<string, unknown>

TCategory

TCategory extends string = string

Properties

allDay?

optional allDay?: boolean

Inherited from

BaseEventProperties.allDay

---

categories?

optional categories?: TCategory[]

Inherited from

BaseEventProperties.categories

---

color?

optional color?: string

Inherited from

BaseEventProperties.color

---

dayOfWeek

dayOfWeek: WeekdayIndex | WeekdayIndex[]

Day of the week, or several. 0=Sunday, 1=Monday, ..., 6=Saturday. A list fires on each selected day every week (ICS BYDAY semantics); with interval, all selected days share one reference week.

Examples

1 // Monday

[1, 3, 5] // Monday, Wednesday, Friday

---

description?

optional description?: string

Inherited from

BaseEventProperties.description

---

duration?

optional duration?: number

Inherited from

BaseEventProperties.duration

---

endDate?

optional endDate?: string

End date for the recurrence (ISO format: YYYY-MM-DD)

Example

"2025-12-31"

Overrides

BaseEventProperties.endDate

---

endTime?

optional endTime?: string

Inherited from

BaseEventProperties.endTime

---

exceptions?

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.

Inherited from

BaseEventProperties.exceptions

---

excludeDates?

optional excludeDates?: string[]

Specific dates to exclude (ISO format: YYYY-MM-DD)

Example

["2025-12-25"] // Skip Christmas

---

icon?

optional icon?: string

Inherited from

BaseEventProperties.icon

---

id

id: string

Inherited from

BaseEventProperties.id

---

interval?

optional interval?: number

Recurrence interval in weeks (default: 1)

Example

2 // Every 2 weeks (bi-weekly)

---

keywords?

optional keywords?: string[]

Inherited from

BaseEventProperties.keywords

---

location?

optional location?: string

Inherited from

BaseEventProperties.location

---

metadata?

optional metadata?: TMetadata

Inherited from

BaseEventProperties.metadata

---

onConflict?

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

Inherited from

BaseEventProperties.onConflict

---

overrideDates?

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.

Example

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

Inherited from

BaseEventProperties.overrideDates

---

priority?

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).

Inherited from

BaseEventProperties.priority

---

reminders?

optional reminders?: Reminder[]

Inherited from

BaseEventProperties.reminders

---

source?

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).

Inherited from

BaseEventProperties.source

---

startDate?

optional startDate?: string

Start date for the recurrence (ISO format: YYYY-MM-DD) Used as reference point for interval calculation

Example

"2025-01-06" // First Monday of 2025

Overrides

BaseEventProperties.startDate

---

startTime?

optional startTime?: string

Inherited from

BaseEventProperties.startTime

---

status?

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

Inherited from

BaseEventProperties.status

---

templates?

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, …).

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

Inherited from

BaseEventProperties.templates

---

title

title: string

Inherited from

BaseEventProperties.title

---

type

type: "weekly"

---

url?

optional url?: string

Inherited from

BaseEventProperties.url