ical-generator 7.0.0-develop.1 → 7.0.0-develop.3

package/dist/index.d.ts

@@ -1,262 +1,449 @@
-interface ICalAttendeeData {
-    name?: string | null;
-    email: string;
-    mailto?: string | null;
-    sentBy?: string | null;
-    status?: ICalAttendeeStatus | null;
-    role?: ICalAttendeeRole;
-    rsvp?: boolean | null;
-    type?: ICalAttendeeType | null;
-    delegatedTo?: ICalAttendee | ICalAttendeeData | string | null;
-    delegatedFrom?: ICalAttendee | ICalAttendeeData | string | null;
-    delegatesTo?: ICalAttendee | ICalAttendeeData | string | null;
-    delegatesFrom?: ICalAttendee | ICalAttendeeData | string | null;
+/**
+ * ical-generator supports [native Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date),
+ * [moment.js](https://momentjs.com/) (and [moment-timezone](https://momentjs.com/timezone/), [Day.js](https://day.js.org/en/) and
+ * [Luxon](https://moment.github.io/luxon/)'s [DateTime](https://moment.github.io/luxon/docs/class/src/datetime.js~DateTime.html)
+ * objects. You can also pass a string which is then passed to javascript's Date internally.
+ */
+type ICalDateTimeValue = Date | ICalMomentStub | ICalMomentTimezoneStub | ICalLuxonDateTimeStub | ICalDayJsStub | string;
+interface ICalRepeatingOptions {
+    freq: ICalEventRepeatingFreq;
+    count?: number;
+    interval?: number;
+    until?: ICalDateTimeValue;
+    byDay?: ICalWeekday[] | ICalWeekday;
+    byMonth?: number[] | number;
+    byMonthDay?: number[] | number;
+    bySetPos?: number[] | number;
+    exclude?: ICalDateTimeValue[] | ICalDateTimeValue;
+    startOfWeek?: ICalWeekday;
+}
+type ICalLocation = ICalLocationWithTitle | ICalLocationWithoutTitle;
+interface ICalLocationWithTitle {
+    title: string;
+    address?: string;
+    radius?: number;
+    geo?: ICalGeo;
+}
+interface ICalLocationWithoutTitle {
+    geo: ICalGeo;
+}
+interface ICalGeo {
+    lat: number;
+    lon: number;
+}
+interface ICalOrganizer {
+    name: string;
+    email?: string;
+    mailto?: string;
+    sentBy?: string;
+}
+interface ICalDescription {
+    plain: string;
+    html?: string;
+}
+interface ICalTimezone {
+    name: string | null;
+    generator?: (timezone: string) => string | null;
+}
+interface ICalMomentStub {
+    format(format?: string): string;
+    clone(): ICalMomentStub;
+    utc(): ICalMomentStub;
+    toDate(): Date;
+    isValid(): boolean;
+    toJSON(): string;
+}
+interface ICalMomentTimezoneStub extends ICalMomentStub {
+    clone(): ICalMomentTimezoneStub;
+    utc(): ICalMomentTimezoneStub;
+    tz(): string | undefined;
+    tz(timezone: string): ICalMomentTimezoneStub;
+}
+interface ICalMomentDurationStub {
+    asSeconds(): number;
+}
+interface ICalLuxonDateTimeStub {
+    setZone(zone?: string): ICalLuxonDateTimeStub;
+    toFormat(fmt: string): string;
+    toJSDate(): Date;
+    get isValid(): boolean;
+    toJSON(): string | null;
+}
+interface ICalDayJsStub {
+    tz(zone?: string): ICalDayJsStub;
+    utc(): ICalDayJsStub;
+    format(format?: string): string;
+    toDate(): Date;
+    isValid(): boolean;
+    toJSON(): string;
+}
+interface ICalRRuleStub {
+    between(after: Date, before: Date, inc?: boolean, iterator?: (d: Date, len: number) => boolean): Date[];
+    toString(): string;
+}
+declare enum ICalEventRepeatingFreq {
+    SECONDLY = "SECONDLY",
+    MINUTELY = "MINUTELY",
+    HOURLY = "HOURLY",
+    DAILY = "DAILY",
+    WEEKLY = "WEEKLY",
+    MONTHLY = "MONTHLY",
+    YEARLY = "YEARLY"
+}
+declare enum ICalWeekday {
+    SU = "SU",
+    MO = "MO",
+    TU = "TU",
+    WE = "WE",
+    TH = "TH",
+    FR = "FR",
+    SA = "SA"
+}
+
+declare enum ICalAlarmType {
+    display = "display",
+    audio = "audio",
+    email = "email"
+}
+declare const ICalAlarmRelatesTo: {
+    readonly end: "END";
+    readonly start: "START";
+};
+type ICalAlarmRelatesTo = typeof ICalAlarmRelatesTo[keyof typeof ICalAlarmRelatesTo];
+type ICalAlarmTypeValue = keyof ICalAlarmType;
+interface ICalAttachment {
+    uri: string;
+    mime: string | null;
+}
+type ICalAlarmData = ICalAlarmBaseData | ICalAlarmTriggerData | ICalAlarmTriggerAfterData | ICalAlarmTriggerBeforeData;
+type ICalAlarmTriggerData = ICalAlarmBaseData & {
+    trigger: number | ICalDateTimeValue;
+};
+type ICalAlarmTriggerAfterData = ICalAlarmBaseData & {
+    triggerAfter: number | ICalDateTimeValue;
+};
+type ICalAlarmTriggerBeforeData = ICalAlarmBaseData & {
+    triggerBefore: number | ICalDateTimeValue;
+};
+interface ICalAlarmBaseData {
+    type?: ICalAlarmType;
+    relatesTo?: ICalAlarmRelatesTo | null;
+    repeat?: ICalAlarmRepeatData | null;
+    attach?: string | ICalAttachment | null;
+    description?: string | null;
+    summary?: string | null;
+    attendees?: ICalAttendee[] | ICalAttendeeData[];
     x?: {
         key: string;
         value: string;
     }[] | [string, string][] | Record<string, string>;
 }
-interface ICalAttendeeJSONData {
-    name: string | null;
-    email: string;
-    mailto: string | null;
-    sentBy: string | null;
-    status: ICalAttendeeStatus | null;
-    role: ICalAttendeeRole;
-    rsvp: boolean | null;
-    type: ICalAttendeeType | null;
-    delegatedTo: string | null;
-    delegatedFrom: string | null;
+interface ICalAlarmRepeatData {
+    times: number;
+    interval: number;
+}
+interface ICalAlarmJSONData {
+    type: ICalAlarmType;
+    trigger: string | number;
+    relatesTo: ICalAlarmRelatesTo | null;
+    repeat: ICalAlarmRepeatData | null;
+    interval: number | null;
+    attach: ICalAttachment | null;
+    description: string | null;
+    summary: string | null;
+    attendees: ICalAttendee[];
     x: {
         key: string;
         value: string;
     }[];
 }
-declare enum ICalAttendeeRole {
-    CHAIR = "CHAIR",
-    REQ = "REQ-PARTICIPANT",
-    OPT = "OPT-PARTICIPANT",
-    NON = "NON-PARTICIPANT"
-}
-declare enum ICalAttendeeStatus {
-    ACCEPTED = "ACCEPTED",
-    TENTATIVE = "TENTATIVE",
-    DECLINED = "DECLINED",
-    DELEGATED = "DELEGATED",
-    NEEDSACTION = "NEEDS-ACTION"
-}
-declare enum ICalAttendeeType {
-    INDIVIDUAL = "INDIVIDUAL",
-    GROUP = "GROUP",
-    RESOURCE = "RESOURCE",
-    ROOM = "ROOM",
-    UNKNOWN = "UNKNOWN"
-}
 /**
- * Usually you get an {@link ICalAttendee} object like this:
+ * Usually you get an {@link ICalAlarm} object like this:
  *
  * ```javascript
  * import ical from 'ical-generator';
  * const calendar = ical();
  * const event = calendar.createEvent();
- * const attendee = event.createAttendee({ email: 'mail@example.com' });
+ * const alarm = event.createAlarm();
  * ```
  *
- * You can also use the {@link ICalAttendee} object directly:
+ * You can also use the {@link ICalAlarm} object directly:
  *
  * ```javascript
- * import ical, {ICalAttendee} from 'ical-generator';
- * const attendee = new ICalAttendee({ email: 'mail@example.com' });
- * event.attendees([attendee]);
+ * import ical, {ICalAlarm} from 'ical-generator';
+ * const alarm = new ICalAlarm();
+ * event.alarms([alarm]);
  * ```
  */
-declare class ICalAttendee {
+declare class ICalAlarm {
     private readonly data;
     private readonly event;
     /**
-     * Constructor of {@link ICalAttendee}. The event reference is
-     * required to query the calendar's timezone when required.
+     * Constructor of {@link ICalAttendee}. The event reference is required
+     * to query the calendar's timezone and summary when required.
      *
-     * @param data Attendee Data
+     * @param data Alarm Data
      * @param event Reference to ICalEvent object
      */
-    constructor(data: ICalAttendeeData, event: ICalEvent);
-    /**
-     * Get the attendee's name
-     * @since 0.2.0
-     */
-    name(): string | null;
-    /**
-     * Set the attendee's name
-     * @since 0.2.0
-     */
-    name(name: string | null): this;
-    /**
-     * Get the attendee's email address
-     * @since 0.2.0
-     */
-    email(): string;
-    /**
-     * Set the attendee's email address
-     * @since 0.2.0
-     */
-    email(email: string): this;
+    constructor(data: ICalAlarmData, event: ICalEvent);
     /**
-     * Get the attendee's email address
-     * @since 1.3.0
+     * Get the alarm type
+     * @since 0.2.1
      */
-    mailto(): string | null;
+    type(type: ICalAlarmType): this;
     /**
-     * Set the attendee's email address
-     * @since 1.3.0
+     * Set the alarm type. See {@link ICalAlarmType}
+     * for available status options.
+     * @since 0.2.1
      */
-    mailto(mailto: string | null): this;
+    type(): ICalAlarmType;
     /**
-     * Get the acting user's email adress
-     * @since 3.3.0
+     * Get the trigger time for the alarm. Can either
+     * be a date and time value ({@link ICalDateTimeValue}) or
+     * a number, which will represent the seconds between
+     * alarm and event start. The number is negative, if the
+     * alarm is triggered after the event started.
+     *
+     * @since 0.2.1
      */
-    sentBy(): string | null;
+    trigger(): number | ICalDateTimeValue;
     /**
-     * Set the acting user's email adress
-     * @since 3.3.0
+     * Use this method to set the alarm time.
+     *
+     * ```javascript
+     * const cal = ical();
+     * const event = cal.createEvent();
+     * const alarm = cal.createAlarm();
+     *
+     * alarm.trigger(600); // -> 10 minutes before event starts
+     * alarm.trigger(new Date()); // -> now
+     * ```
+     *
+     * You can use any supported date object, see
+     * [readme](https://github.com/sebbo2002/ical-generator#-date-time--timezones)
+     * for details about supported values and timezone handling.
+     *
+     * @since 0.2.1
      */
-    sentBy(email: string | null): this;
+    trigger(trigger: number | ICalDateTimeValue | Date): this;
     /**
-     * Get attendee's role
-     * @since 0.2.0
+     * Get to which time alarm trigger relates to.
+     * Can be either `START` or `END`. If the value is
+     * `START` the alarm is triggerd relative to the event start time.
+     * If the value is `END` the alarm is triggerd relative to the event end time
+     *
+     * @since 4.0.1
      */
-    role(): ICalAttendeeRole;
+    relatesTo(): ICalAlarmRelatesTo | null;
     /**
-     * Set the attendee's role, defaults to `REQ` / `REQ-PARTICIPANT`.
-     * Checkout {@link ICalAttendeeRole} for available roles.
+     * Use this method to set to which time alarm trigger relates to.
+     * Works only if trigger is a `number`
      *
-     * @since 0.2.0
+     * ```javascript
+     * const cal = ical();
+     * const event = cal.createEvent();
+     * const alarm = cal.createAlarm();
+     *
+     * alarm.trigger(600); // -> 10 minutes before event starts
+     *
+     * alarm.relatesTo('START'); // -> 10 minutes before event starts
+     * alarm.relatesTo('END'); // -> 10 minutes before event ends
+     *
+     * alarm.trigger(-600); // -> 10 minutes after event starts
+     *
+     * alarm.relatesTo('START'); // -> 10 minutes after event starts
+     * alarm.relatesTo('END'); // -> 10 minutes after event ends
+     * ```
+     * @since 4.0.1
      */
-    role(role: ICalAttendeeRole): this;
+    relatesTo(relatesTo: ICalAlarmRelatesTo | null): this;
     /**
-     * Get attendee's RSVP expectation
+     * Get the trigger time for the alarm. Can either
+     * be a date and time value ({@link ICalDateTimeValue}) or
+     * a number, which will represent the seconds between
+     * alarm and event start. The number is negative, if the
+     * alarm is triggered before the event started.
+     *
      * @since 0.2.1
      */
-    rsvp(): boolean | null;
+    triggerAfter(): number | ICalDateTimeValue;
     /**
-     * Set the attendee's RSVP expectation
+     * Use this method to set the alarm time. Unlike `trigger`, this time
+     * the alarm takes place after the event has started.
+     *
+     * ```javascript
+     * const cal = ical();
+     * const event = cal.createEvent();
+     * const alarm = cal.createAlarm();
+     *
+     * alarm.trigger(600); // -> 10 minutes after event starts
+     * ```
+     *
+     * You can use any supported date object, see
+     * [readme](https://github.com/sebbo2002/ical-generator#-date-time--timezones)
+     * for details about supported values and timezone handling.
+     *
      * @since 0.2.1
      */
-    rsvp(rsvp: boolean | null): this;
+    triggerAfter(trigger: number | ICalDateTimeValue): this;
     /**
-     * Get attendee's status
-     * @since 0.2.0
+     * Get the trigger time for the alarm. Can either
+     * be a date and time value ({@link ICalDateTimeValue}) or
+     * a number, which will represent the seconds between
+     * alarm and event start. The number is negative, if the
+     * alarm is triggered after the event started.
+     *
+     * @since 0.2.1
+     * @alias trigger
      */
-    status(): ICalAttendeeStatus | null;
+    triggerBefore(trigger: number | ICalDateTimeValue): this;
     /**
-     * Set the attendee's status. See {@link ICalAttendeeStatus}
-     * for available status options.
+     * Use this method to set the alarm time.
      *
-     * @since 0.2.0
+     * ```javascript
+     * const cal = ical();
+     * const event = cal.createEvent();
+     * const alarm = cal.createAlarm();
+     *
+     * alarm.trigger(600); // -> 10 minutes before event starts
+     * alarm.trigger(new Date()); // -> now
+     * ```
+     *
+     * You can use any supported date object, see
+     * [readme](https://github.com/sebbo2002/ical-generator#-date-time--timezones)
+     * for details about supported values and timezone handling.
+     *
+     * @since 0.2.1
+     * @alias trigger
      */
-    status(status: ICalAttendeeStatus | null): this;
+    triggerBefore(): number | ICalDateTimeValue;
     /**
-     * Get attendee's type (a.k.a. CUTYPE)
-     * @since 0.2.3
+     * Get Alarm Repetitions
+     * @since 0.2.1
      */
-    type(): ICalAttendeeType;
+    repeat(): ICalAlarmRepeatData | null;
     /**
-     * Set attendee's type (a.k.a. CUTYPE).
-     * See {@link ICalAttendeeType} for available status options.
+     * Set Alarm Repetitions. Use this to repeat the alarm.
      *
-     * @since 0.2.3
+     * ```javascript
+     * const cal = ical();
+     * const event = cal.createEvent();
+     *
+     * // repeat the alarm 4 times every 5 minutes…
+     * cal.createAlarm({
+     *     repeat: {
+     *         times: 4,
+     *         interval: 300
+     *     }
+     * });
+     * ```
+     *
+     * @since 0.2.1
      */
-    type(type: ICalAttendeeType | null): this;
+    repeat(repeat: ICalAlarmRepeatData | null): this;
     /**
-     * Get the attendee's delegated-to value.
-     * @since 0.2.0
+     * Get Attachment
+     * @since 0.2.1
      */
-    delegatedTo(): ICalAttendee | null;
+    attach(): {
+        uri: string;
+        mime: string | null;
+    } | null;
     /**
-     * Set the attendee's delegated-to field.
-     *
-     * Creates a new Attendee if the passed object is not already a
-     * {@link ICalAttendee} object. Will set the `delegatedTo` and
-     * `delegatedFrom` attributes.
-     *
-     * Will also set the `status` to `DELEGATED`, if attribute is set.
+     * Set Alarm attachment. Used to set the alarm sound
+     * if alarm type is audio. Defaults to "Basso".
      *
      * ```javascript
      * const cal = ical();
      * const event = cal.createEvent();
-     * const attendee = cal.createAttendee();
      *
-     * attendee.delegatesTo({email: 'foo@bar.com', name: 'Foo'});
-     ```
+     * event.createAlarm({
+     *     attach: 'https://example.com/notification.aud'
+     * });
      *
-     * @since 0.2.0
+     * // OR
+     *
+     * event.createAlarm({
+     *     attach: {
+     *         uri: 'https://example.com/notification.aud',
+     *         mime: 'audio/basic'
+     *     }
+     * });
+     * ```
+     *
+     * @since 0.2.1
      */
-    delegatedTo(delegatedTo: ICalAttendee | ICalAttendeeData | string | null): this;
+    attach(attachment: {
+        uri: string;
+        mime?: string | null;
+    } | string | null): this;
     /**
-     * Get the attendee's delegated-from field
-     * @since 0.2.0
+     * Get the alarm description. Used to set the alarm message
+     * if alarm type is `display`. If the alarm type is `email`, it's
+     * used to set the email body. Defaults to the event's summary.
+     *
+     * @since 0.2.1
      */
-    delegatedFrom(): ICalAttendee | null;
+    description(): string | null;
     /**
-     * Set the attendee's delegated-from field
-     *
-     * Creates a new Attendee if the passed object is not already a
-     * {@link ICalAttendee} object. Will set the `delegatedTo` and
-     * `delegatedFrom` attributes.
+     * Set the alarm description. Used to set the alarm message
+     * if alarm type is `display`. If the alarm type is `email`, it's
+     * used to set the email body. Defaults to the event's summary.
      *
-     * @param delegatedFrom
+     * @since 0.2.1
      */
-    delegatedFrom(delegatedFrom: ICalAttendee | ICalAttendeeData | string | null): this;
+    description(description: string | null): this;
     /**
-     * Create a new attendee this attendee delegates to and returns
-     * this new attendee. Creates a new attendee if the passed object
-     * is not already an {@link ICalAttendee}.
+     * Get the alarm summary. Used to set the email subject
+     * if alarm type is `email`. Defaults to the event's summary.
      *
-     * ```javascript
-     * const cal = ical();
-     * const event = cal.createEvent();
-     * const attendee = cal.createAttendee();
-     *
-     * attendee.delegatesTo({email: 'foo@bar.com', name: 'Foo'});
-     * ```
-     *
-     * @since 0.2.0
+     * @since 7.0.0
      */
-    delegatesTo(options: ICalAttendee | ICalAttendeeData | string): ICalAttendee;
+    summary(): string | null;
     /**
-     * Create a new attendee this attendee delegates from and returns
-     * this new attendee. Creates a new attendee if the passed object
-     * is not already an {@link ICalAttendee}.
+     * Set the alarm summary. Used to set the email subject
+     * if alarm type is display. Defaults to the event's summary.
      *
-     * ```javascript
-     * const cal = ical();
-     * const event = cal.createEvent();
-     * const attendee = cal.createAttendee();
+     * @since 0.2.1
+     */
+    summary(summary: string | null): this;
+    /**
+     * Creates a new {@link ICalAttendee} and returns it. Use options to prefill
+     * the attendee's attributes. Calling this method without options will create
+     * an empty attendee.
      *
-     * attendee.delegatesFrom({email: 'foo@bar.com', name: 'Foo'});
-     * ```
+     * @since 7.0.0
+     */
+    createAttendee(data: ICalAttendee | ICalAttendeeData | string): ICalAttendee;
+    /**
+     * Get all attendees
+     * @since 7.0.0
+     */
+    attendees(): ICalAttendee[];
+    /**
+     * Add multiple attendees to your event
      *
-     * @since 0.2.0
+     * @since 7.0.0
      */
-    delegatesFrom(options: ICalAttendee | ICalAttendeeData | string): ICalAttendee;
+    attendees(attendees: (ICalAttendee | ICalAttendeeData | string)[]): this;
     /**
      * Set X-* attributes. Woun't filter double attributes,
-     * which are also added by another method (e.g. status),
+     * which are also added by another method (e.g. type),
      * so these attributes may be inserted twice.
      *
      * ```javascript
-     * attendee.x([
+     * alarm.x([
      *     {
      *         key: "X-MY-CUSTOM-ATTR",
      *         value: "1337!"
      *     }
      * ]);
      *
-     * attendee.x([
+     * alarm.x([
      *     ["X-MY-CUSTOM-ATTR", "1337!"]
      * ]);
      *
-     * attendee.x({
+     * alarm.x({
      *     "X-MY-CUSTOM-ATTR": "1337!"
      * });
      * ```
@@ -269,11 +456,11 @@ declare class ICalAttendee {
     }[] | [string, string][] | Record<string, string>): this;
     /**
      * Set a X-* attribute. Woun't filter double attributes,
-     * which are also added by another method (e.g. status),
+     * which are also added by another method (e.g. type),
      * so these attributes may be inserted twice.
      *
      * ```javascript
-     * attendee.x("X-MY-CUSTOM-ATTR", "1337!");
+     * alarm.x("X-MY-CUSTOM-ATTR", "1337!");
      * ```
      *
      * @since 1.9.0
@@ -288,428 +475,283 @@ declare class ICalAttendee {
         value: string;
     }[];
     /**
-     * Return a shallow copy of the attendee's options for JSON stringification.
-     * Can be used for persistence.
+     * Return a shallow copy of the alarm's options for JSON stringification.
+     * Third party objects like moment.js values are stringified as well. Can
+     * be used for persistence.
      *
      * @since 0.2.4
      */
-    toJSON(): ICalAttendeeJSONData;
+    toJSON(): ICalAlarmJSONData;
     /**
-     * Return generated attendee as a string.
+     * Return generated event as a string.
      *
      * ```javascript
-     * console.log(attendee.toString()); // → ATTENDEE;ROLE=…
+     * const alarm = event.createAlarm();
+     * console.log(alarm.toString()); // → BEGIN:VALARM…
      * ```
      */
     toString(): string;
 }
 
-/**
- * ical-generator supports [native Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date),
- * [moment.js](https://momentjs.com/) (and [moment-timezone](https://momentjs.com/timezone/), [Day.js](https://day.js.org/en/) and
- * [Luxon](https://moment.github.io/luxon/)'s [DateTime](https://moment.github.io/luxon/docs/class/src/datetime.js~DateTime.html)
- * objects. You can also pass a string which is then passed to javascript's Date internally.
- */
-type ICalDateTimeValue = Date | ICalMomentStub | ICalMomentTimezoneStub | ICalLuxonDateTimeStub | ICalDayJsStub | string;
-interface ICalRepeatingOptions {
-    freq: ICalEventRepeatingFreq;
-    count?: number;
-    interval?: number;
-    until?: ICalDateTimeValue;
-    byDay?: ICalWeekday[] | ICalWeekday;
-    byMonth?: number[] | number;
-    byMonthDay?: number[] | number;
-    bySetPos?: number[] | number;
-    exclude?: ICalDateTimeValue[] | ICalDateTimeValue;
-    startOfWeek?: ICalWeekday;
-}
-type ICalLocation = ICalLocationWithTitle | ICalLocationWithoutTitle;
-interface ICalLocationWithTitle {
-    title: string;
-    address?: string;
-    radius?: number;
-    geo?: ICalGeo;
-}
-interface ICalLocationWithoutTitle {
-    geo: ICalGeo;
-}
-interface ICalGeo {
-    lat: number;
-    lon: number;
-}
-interface ICalOrganizer {
-    name: string;
-    email?: string;
-    mailto?: string;
-    sentBy?: string;
-}
-interface ICalDescription {
-    plain: string;
-    html?: string;
-}
-interface ICalTimezone {
-    name: string | null;
-    generator?: (timezone: string) => string | null;
-}
-interface ICalMomentStub {
-    format(format?: string): string;
-    clone(): ICalMomentStub;
-    utc(): ICalMomentStub;
-    toDate(): Date;
-    isValid(): boolean;
-    toJSON(): string;
-}
-interface ICalMomentTimezoneStub extends ICalMomentStub {
-    clone(): ICalMomentTimezoneStub;
-    utc(): ICalMomentTimezoneStub;
-    tz(): string | undefined;
-    tz(timezone: string): ICalMomentTimezoneStub;
-}
-interface ICalMomentDurationStub {
-    asSeconds(): number;
-}
-interface ICalLuxonDateTimeStub {
-    setZone(zone?: string): ICalLuxonDateTimeStub;
-    toFormat(fmt: string): string;
-    toJSDate(): Date;
-    get isValid(): boolean;
-    toJSON(): string | null;
-}
-interface ICalDayJsStub {
-    tz(zone?: string): ICalDayJsStub;
-    utc(): ICalDayJsStub;
-    format(format?: string): string;
-    toDate(): Date;
-    isValid(): boolean;
-    toJSON(): string;
-}
-interface ICalRRuleStub {
-    between(after: Date, before: Date, inc?: boolean, iterator?: (d: Date, len: number) => boolean): Date[];
-    toString(): string;
-}
-declare enum ICalEventRepeatingFreq {
-    SECONDLY = "SECONDLY",
-    MINUTELY = "MINUTELY",
-    HOURLY = "HOURLY",
-    DAILY = "DAILY",
-    WEEKLY = "WEEKLY",
-    MONTHLY = "MONTHLY",
-    YEARLY = "YEARLY"
-}
-declare enum ICalWeekday {
-    SU = "SU",
-    MO = "MO",
-    TU = "TU",
-    WE = "WE",
-    TH = "TH",
-    FR = "FR",
-    SA = "SA"
-}
-
-declare enum ICalAlarmType {
-    display = "display",
-    audio = "audio"
-}
-declare const ICalAlarmRelatesTo: {
-    readonly end: "END";
-    readonly start: "START";
-};
-type ICalAlarmRelatesTo = typeof ICalAlarmRelatesTo[keyof typeof ICalAlarmRelatesTo];
-type ICalAlarmTypeValue = keyof ICalAlarmType;
-interface ICalAttachment {
-    uri: string;
-    mime: string | null;
-}
-type ICalAlarmData = ICalAlarmBaseData | ICalAlarmTriggerData | ICalAlarmTriggerAfterData | ICalAlarmTriggerBeforeData;
-type ICalAlarmTriggerData = ICalAlarmBaseData & {
-    trigger: number | ICalDateTimeValue;
-};
-type ICalAlarmTriggerAfterData = ICalAlarmBaseData & {
-    triggerAfter: number | ICalDateTimeValue;
-};
-type ICalAlarmTriggerBeforeData = ICalAlarmBaseData & {
-    triggerBefore: number | ICalDateTimeValue;
-};
-interface ICalAlarmBaseData {
-    type?: ICalAlarmType;
-    relatesTo?: ICalAlarmRelatesTo | null;
-    repeat?: ICalAlarmRepeatData | null;
-    attach?: string | ICalAttachment | null;
-    description?: string | null;
+interface ICalAttendeeData {
+    name?: string | null;
+    email: string;
+    mailto?: string | null;
+    sentBy?: string | null;
+    status?: ICalAttendeeStatus | null;
+    role?: ICalAttendeeRole;
+    rsvp?: boolean | null;
+    type?: ICalAttendeeType | null;
+    delegatedTo?: ICalAttendee | ICalAttendeeData | string | null;
+    delegatedFrom?: ICalAttendee | ICalAttendeeData | string | null;
+    delegatesTo?: ICalAttendee | ICalAttendeeData | string | null;
+    delegatesFrom?: ICalAttendee | ICalAttendeeData | string | null;
     x?: {
         key: string;
         value: string;
     }[] | [string, string][] | Record<string, string>;
 }
-interface ICalAlarmRepeatData {
-    times: number;
-    interval: number;
-}
-interface ICalAlarmJSONData {
-    type: ICalAlarmType;
-    trigger: string | number;
-    relatesTo: ICalAlarmRelatesTo | null;
-    repeat: ICalAlarmRepeatData | null;
-    interval: number | null;
-    attach: ICalAttachment | null;
-    description: string | null;
+interface ICalAttendeeJSONData {
+    name: string | null;
+    email: string;
+    mailto: string | null;
+    sentBy: string | null;
+    status: ICalAttendeeStatus | null;
+    role: ICalAttendeeRole;
+    rsvp: boolean | null;
+    type: ICalAttendeeType | null;
+    delegatedTo: string | null;
+    delegatedFrom: string | null;
     x: {
         key: string;
         value: string;
     }[];
 }
+declare enum ICalAttendeeRole {
+    CHAIR = "CHAIR",
+    REQ = "REQ-PARTICIPANT",
+    OPT = "OPT-PARTICIPANT",
+    NON = "NON-PARTICIPANT"
+}
+declare enum ICalAttendeeStatus {
+    ACCEPTED = "ACCEPTED",
+    TENTATIVE = "TENTATIVE",
+    DECLINED = "DECLINED",
+    DELEGATED = "DELEGATED",
+    NEEDSACTION = "NEEDS-ACTION"
+}
+declare enum ICalAttendeeType {
+    INDIVIDUAL = "INDIVIDUAL",
+    GROUP = "GROUP",
+    RESOURCE = "RESOURCE",
+    ROOM = "ROOM",
+    UNKNOWN = "UNKNOWN"
+}
 /**
- * Usually you get an {@link ICalAlarm} object like this:
+ * Usually you get an {@link ICalAttendee} object like this:
  *
  * ```javascript
  * import ical from 'ical-generator';
  * const calendar = ical();
  * const event = calendar.createEvent();
- * const alarm = event.createAlarm();
+ * const attendee = event.createAttendee({ email: 'mail@example.com' });
  * ```
  *
- * You can also use the {@link ICalAlarm} object directly:
+ * You can also use the {@link ICalAttendee} object directly:
  *
  * ```javascript
- * import ical, {ICalAlarm} from 'ical-generator';
- * const alarm = new ICalAlarm();
- * event.alarms([alarm]);
+ * import ical, {ICalAttendee} from 'ical-generator';
+ * const attendee = new ICalAttendee({ email: 'mail@example.com' });
+ * event.attendees([attendee]);
  * ```
  */
-declare class ICalAlarm {
+declare class ICalAttendee {
     private readonly data;
-    private readonly event;
+    private readonly parent;
+    /**
+     * Constructor of {@link ICalAttendee}. The event reference is
+     * required to query the calendar's timezone when required.
+     *
+     * @param data Attendee Data
+     * @param parent Reference to ICalEvent object
+     */
+    constructor(data: ICalAttendeeData, parent: ICalEvent | ICalAlarm);
+    /**
+     * Get the attendee's name
+     * @since 0.2.0
+     */
+    name(): string | null;
+    /**
+     * Set the attendee's name
+     * @since 0.2.0
+     */
+    name(name: string | null): this;
+    /**
+     * Get the attendee's email address
+     * @since 0.2.0
+     */
+    email(): string;
+    /**
+     * Set the attendee's email address
+     * @since 0.2.0
+     */
+    email(email: string): this;
+    /**
+     * Get the attendee's email address
+     * @since 1.3.0
+     */
+    mailto(): string | null;
+    /**
+     * Set the attendee's email address
+     * @since 1.3.0
+     */
+    mailto(mailto: string | null): this;
+    /**
+     * Get the acting user's email adress
+     * @since 3.3.0
+     */
+    sentBy(): string | null;
     /**
-     * Constructor of {@link ICalAttendee}. The event reference is required
-     * to query the calendar's timezone and summary when required.
+     * Set the acting user's email adress
+     * @since 3.3.0
+     */
+    sentBy(email: string | null): this;
+    /**
+     * Get attendee's role
+     * @since 0.2.0
+     */
+    role(): ICalAttendeeRole;
+    /**
+     * Set the attendee's role, defaults to `REQ` / `REQ-PARTICIPANT`.
+     * Checkout {@link ICalAttendeeRole} for available roles.
      *
-     * @param data Alarm Data
-     * @param event Reference to ICalEvent object
+     * @since 0.2.0
      */
-    constructor(data: ICalAlarmData, event: ICalEvent);
+    role(role: ICalAttendeeRole): this;
     /**
-     * Get the alarm type
+     * Get attendee's RSVP expectation
      * @since 0.2.1
      */
-    type(type: ICalAlarmType): this;
+    rsvp(): boolean | null;
     /**
-     * Set the alarm type. See {@link ICalAlarmType}
-     * for available status options.
+     * Set the attendee's RSVP expectation
      * @since 0.2.1
      */
-    type(): ICalAlarmType;
+    rsvp(rsvp: boolean | null): this;
     /**
-     * Get the trigger time for the alarm. Can either
-     * be a date and time value ({@link ICalDateTimeValue}) or
-     * a number, which will represent the seconds between
-     * alarm and event start. The number is negative, if the
-     * alarm is triggered after the event started.
-     *
-     * @since 0.2.1
+     * Get attendee's status
+     * @since 0.2.0
      */
-    trigger(): number | ICalDateTimeValue;
+    status(): ICalAttendeeStatus | null;
     /**
-     * Use this method to set the alarm time.
-     *
-     * ```javascript
-     * const cal = ical();
-     * const event = cal.createEvent();
-     * const alarm = cal.createAlarm();
-     *
-     * alarm.trigger(600); // -> 10 minutes before event starts
-     * alarm.trigger(new Date()); // -> now
-     * ```
-     *
-     * You can use any supported date object, see
-     * [readme](https://github.com/sebbo2002/ical-generator#-date-time--timezones)
-     * for details about supported values and timezone handling.
+     * Set the attendee's status. See {@link ICalAttendeeStatus}
+     * for available status options.
      *
-     * @since 0.2.1
+     * @since 0.2.0
      */
-    trigger(trigger: number | ICalDateTimeValue | Date): this;
+    status(status: ICalAttendeeStatus | null): this;
     /**
-     * Get to which time alarm trigger relates to.
-     * Can be either `START` or `END`. If the value is
-     * `START` the alarm is triggerd relative to the event start time.
-     * If the value is `END` the alarm is triggerd relative to the event end time
-     *
-     * @since 4.0.1
+     * Get attendee's type (a.k.a. CUTYPE)
+     * @since 0.2.3
      */
-    relatesTo(): ICalAlarmRelatesTo | null;
+    type(): ICalAttendeeType;
     /**
-     * Use this method to set to which time alarm trigger relates to.
-     * Works only if trigger is a `number`
-     *
-     * ```javascript
-     * const cal = ical();
-     * const event = cal.createEvent();
-     * const alarm = cal.createAlarm();
-     *
-     * alarm.trigger(600); // -> 10 minutes before event starts
-     *
-     * alarm.relatesTo('START'); // -> 10 minutes before event starts
-     * alarm.relatesTo('END'); // -> 10 minutes before event ends
-     *
-     * alarm.trigger(-600); // -> 10 minutes after event starts
+     * Set attendee's type (a.k.a. CUTYPE).
+     * See {@link ICalAttendeeType} for available status options.
      *
-     * alarm.relatesTo('START'); // -> 10 minutes after event starts
-     * alarm.relatesTo('END'); // -> 10 minutes after event ends
-     * ```
-     * @since 4.0.1
+     * @since 0.2.3
      */
-    relatesTo(relatesTo: ICalAlarmRelatesTo | null): this;
+    type(type: ICalAttendeeType | null): this;
     /**
-     * Get the trigger time for the alarm. Can either
-     * be a date and time value ({@link ICalDateTimeValue}) or
-     * a number, which will represent the seconds between
-     * alarm and event start. The number is negative, if the
-     * alarm is triggered before the event started.
-     *
-     * @since 0.2.1
+     * Get the attendee's delegated-to value.
+     * @since 0.2.0
      */
-    triggerAfter(): number | ICalDateTimeValue;
+    delegatedTo(): ICalAttendee | null;
     /**
-     * Use this method to set the alarm time. Unlike `trigger`, this time
-     * the alarm takes place after the event has started.
+     * Set the attendee's delegated-to field.
+     *
+     * Creates a new Attendee if the passed object is not already a
+     * {@link ICalAttendee} object. Will set the `delegatedTo` and
+     * `delegatedFrom` attributes.
+     *
+     * Will also set the `status` to `DELEGATED`, if attribute is set.
      *
      * ```javascript
      * const cal = ical();
      * const event = cal.createEvent();
-     * const alarm = cal.createAlarm();
-     *
-     * alarm.trigger(600); // -> 10 minutes after event starts
-     * ```
+     * const attendee = cal.createAttendee();
      *
-     * You can use any supported date object, see
-     * [readme](https://github.com/sebbo2002/ical-generator#-date-time--timezones)
-     * for details about supported values and timezone handling.
+     * attendee.delegatesTo({email: 'foo@bar.com', name: 'Foo'});
+     ```
      *
-     * @since 0.2.1
+     * @since 0.2.0
      */
-    triggerAfter(trigger: number | ICalDateTimeValue): this;
+    delegatedTo(delegatedTo: ICalAttendee | ICalAttendeeData | string | null): this;
     /**
-     * Get the trigger time for the alarm. Can either
-     * be a date and time value ({@link ICalDateTimeValue}) or
-     * a number, which will represent the seconds between
-     * alarm and event start. The number is negative, if the
-     * alarm is triggered after the event started.
-     *
-     * @since 0.2.1
-     * @alias trigger
+     * Get the attendee's delegated-from field
+     * @since 0.2.0
      */
-    triggerBefore(trigger: number | ICalDateTimeValue): this;
+    delegatedFrom(): ICalAttendee | null;
     /**
-     * Use this method to set the alarm time.
-     *
-     * ```javascript
-     * const cal = ical();
-     * const event = cal.createEvent();
-     * const alarm = cal.createAlarm();
-     *
-     * alarm.trigger(600); // -> 10 minutes before event starts
-     * alarm.trigger(new Date()); // -> now
-     * ```
+     * Set the attendee's delegated-from field
      *
-     * You can use any supported date object, see
-     * [readme](https://github.com/sebbo2002/ical-generator#-date-time--timezones)
-     * for details about supported values and timezone handling.
+     * Creates a new Attendee if the passed object is not already a
+     * {@link ICalAttendee} object. Will set the `delegatedTo` and
+     * `delegatedFrom` attributes.
      *
-     * @since 0.2.1
-     * @alias trigger
-     */
-    triggerBefore(): number | ICalDateTimeValue;
-    /**
-     * Get Alarm Repetitions
-     * @since 0.2.1
+     * @param delegatedFrom
      */
-    repeat(): ICalAlarmRepeatData | null;
+    delegatedFrom(delegatedFrom: ICalAttendee | ICalAttendeeData | string | null): this;
     /**
-     * Set Alarm Repetitions. Use this to repeat the alarm.
+     * Create a new attendee this attendee delegates to and returns
+     * this new attendee. Creates a new attendee if the passed object
+     * is not already an {@link ICalAttendee}.
      *
      * ```javascript
      * const cal = ical();
      * const event = cal.createEvent();
+     * const attendee = cal.createAttendee();
      *
-     * // repeat the alarm 4 times every 5 minutes…
-     * cal.createAlarm({
-     *     repeat: {
-     *         times: 4,
-     *         interval: 300
-     *     }
-     * });
+     * attendee.delegatesTo({email: 'foo@bar.com', name: 'Foo'});
      * ```
      *
-     * @since 0.2.1
-     */
-    repeat(repeat: ICalAlarmRepeatData | null): this;
-    /**
-     * Get Attachment
-     * @since 0.2.1
+     * @since 0.2.0
      */
-    attach(): {
-        uri: string;
-        mime: string | null;
-    } | null;
+    delegatesTo(options: ICalAttendee | ICalAttendeeData | string): ICalAttendee;
     /**
-     * Set Alarm attachment. Used to set the alarm sound
-     * if alarm type is audio. Defaults to "Basso".
+     * Create a new attendee this attendee delegates from and returns
+     * this new attendee. Creates a new attendee if the passed object
+     * is not already an {@link ICalAttendee}.
      *
      * ```javascript
      * const cal = ical();
      * const event = cal.createEvent();
+     * const attendee = cal.createAttendee();
      *
-     * event.createAlarm({
-     *     attach: 'https://example.com/notification.aud'
-     * });
-     *
-     * // OR
-     *
-     * event.createAlarm({
-     *     attach: {
-     *         uri: 'https://example.com/notification.aud',
-     *         mime: 'audio/basic'
-     *     }
-     * });
+     * attendee.delegatesFrom({email: 'foo@bar.com', name: 'Foo'});
      * ```
      *
-     * @since 0.2.1
-     */
-    attach(attachment: {
-        uri: string;
-        mime?: string | null;
-    } | string | null): this;
-    /**
-     * Get the alarm description. Used to set the alarm message
-     * if alarm type is display. Defaults to the event's summary.
-     *
-     * @since 0.2.1
-     */
-    description(): string | null;
-    /**
-     * Set the alarm description. Used to set the alarm message
-     * if alarm type is display. Defaults to the event's summary.
-     *
-     * @since 0.2.1
+     * @since 0.2.0
      */
-    description(description: string | null): this;
+    delegatesFrom(options: ICalAttendee | ICalAttendeeData | string): ICalAttendee;
     /**
      * Set X-* attributes. Woun't filter double attributes,
-     * which are also added by another method (e.g. type),
+     * which are also added by another method (e.g. status),
      * so these attributes may be inserted twice.
      *
      * ```javascript
-     * alarm.x([
+     * attendee.x([
      *     {
      *         key: "X-MY-CUSTOM-ATTR",
      *         value: "1337!"
      *     }
      * ]);
      *
-     * alarm.x([
+     * attendee.x([
      *     ["X-MY-CUSTOM-ATTR", "1337!"]
      * ]);
      *
-     * alarm.x({
+     * attendee.x({
      *     "X-MY-CUSTOM-ATTR": "1337!"
      * });
      * ```
@@ -722,11 +764,11 @@ declare class ICalAlarm {
     }[] | [string, string][] | Record<string, string>): this;
     /**
      * Set a X-* attribute. Woun't filter double attributes,
-     * which are also added by another method (e.g. type),
+     * which are also added by another method (e.g. status),
      * so these attributes may be inserted twice.
      *
      * ```javascript
-     * alarm.x("X-MY-CUSTOM-ATTR", "1337!");
+     * attendee.x("X-MY-CUSTOM-ATTR", "1337!");
      * ```
      *
      * @since 1.9.0
@@ -741,19 +783,17 @@ declare class ICalAlarm {
         value: string;
     }[];
     /**
-     * Return a shallow copy of the alarm's options for JSON stringification.
-     * Third party objects like moment.js values are stringified as well. Can
-     * be used for persistence.
+     * Return a shallow copy of the attendee's options for JSON stringification.
+     * Can be used for persistence.
      *
      * @since 0.2.4
      */
-    toJSON(): ICalAlarmJSONData;
+    toJSON(): ICalAttendeeJSONData;
     /**
-     * Return generated event as a string.
+     * Return generated attendee as a string.
      *
      * ```javascript
-     * const alarm = event.createAlarm();
-     * console.log(alarm.toString()); // → BEGIN:VALARM…
+     * console.log(attendee.toString()); // → ATTENDEE;ROLE=…
      * ```
      */
     toString(): string;
@@ -1033,6 +1073,11 @@ declare class ICalEvent {
      * @since 0.2.0
      */
     end(end: ICalDateTimeValue | null): this;
+    /**
+     * Checks if the start date is after the end date and swaps them if necessary.
+     * @private
+     */
+    private swapStartAndEndIfRequired;
     /**
      * Get the event's recurrence id
      * @since 0.2.0