datebook/dist/src/types/CalendarRecurrence.d.ts

Generates URLs and ICS file content for adding events to popular calendar apps.

/**
 * Recurrence config options.
 */
type CalendarRecurrence = {
    /** The Julian interval of how often this event should occur. */
    frequency?: string;
    /** The amount of time that will occur between recurrences. The scale of the time depends on {@link CalendarRecurrence.frequency}. */
    interval?: number;
    /** The maximum number of times the event should repeat. */
    count?: number;
    /** The latest date that this event may occur on.  */
    end?: Date;
    /** The day of the week to denote when the the week starts on. */
    weekstart?: string;
    /** The days of the week that the event should occur on. */
    weekdays?: string[];
    /** The days of the month that the event should occur on.  */
    monthdays?: number[];
    /** The month number (1-12) of the annual recurrence. */
    month?: number;
};
export default CalendarRecurrence;