ical-generator 6.0.2-develop.1 → 6.0.2-develop.10

package/dist/index.d.cts

@@ -53,7 +53,7 @@ declare enum ICalAttendeeType {
     UNKNOWN = "UNKNOWN"
 }
 /**
- * Usually you get an `ICalAttendee` object like this:
+ * Usually you get an {@link ICalAttendee} object like this:
  *
  * ```javascript
  * import ical from 'ical-generator';
@@ -62,7 +62,7 @@ declare enum ICalAttendeeType {
  * const attendee = event.createAttendee({ email: 'mail@example.com' });
  * ```
  *
- * You can also use the [[`ICalAttendee`]] object directly:
+ * You can also use the {@link ICalAttendee} object directly:
  *
  * ```javascript
  * import ical, {ICalAttendee} from 'ical-generator';
@@ -74,11 +74,11 @@ declare class ICalAttendee {
     private readonly data;
     private readonly event;
     /**
-     * Constructor of [[`ICalAttendee`]]. The event reference is
+     * Constructor of {@link ICalAttendee}. The event reference is
      * required to query the calendar's timezone when required.
      *
      * @param data Attendee Data
-     * @param calendar Reference to ICalEvent object
+     * @param event Reference to ICalEvent object
      */
     constructor(data: ICalAttendeeData, event: ICalEvent);
     /**
@@ -128,7 +128,7 @@ declare class ICalAttendee {
     role(): ICalAttendeeRole;
     /**
      * Set the attendee's role, defaults to `REQ` / `REQ-PARTICIPANT`.
-     * Checkout [[`ICalAttendeeRole`]] for available roles.
+     * Checkout {@link ICalAttendeeRole} for available roles.
      *
      * @since 0.2.0
      */
@@ -149,7 +149,7 @@ declare class ICalAttendee {
      */
     status(): ICalAttendeeStatus | null;
     /**
-     * Set the attendee's status. See [[`ICalAttendeeStatus`]]
+     * Set the attendee's status. See {@link ICalAttendeeStatus}
      * for available status options.
      *
      * @since 0.2.0
@@ -162,7 +162,7 @@ declare class ICalAttendee {
     type(): ICalAttendeeType;
     /**
      * Set attendee's type (a.k.a. CUTYPE).
-     * See [[`ICalAttendeeType`]] for available status options.
+     * See {@link ICalAttendeeType} for available status options.
      *
      * @since 0.2.3
      */
@@ -176,7 +176,7 @@ declare class ICalAttendee {
      * Set the attendee's delegated-to field.
      *
      * Creates a new Attendee if the passed object is not already a
-     * [[`ICalAttendee`]] object. Will set the `delegatedTo` and
+     * {@link ICalAttendee} object. Will set the `delegatedTo` and
      * `delegatedFrom` attributes.
      *
      * Will also set the `status` to `DELEGATED`, if attribute is set.
@@ -201,7 +201,7 @@ declare class ICalAttendee {
      * Set the attendee's delegated-from field
      *
      * Creates a new Attendee if the passed object is not already a
-     * [[`ICalAttendee`]] object. Will set the `delegatedTo` and
+     * {@link ICalAttendee} object. Will set the `delegatedTo` and
      * `delegatedFrom` attributes.
      *
      * @param delegatedFrom
@@ -210,7 +210,7 @@ declare class ICalAttendee {
     /**
      * 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 [[`ICalAttendee`]].
+     * is not already an {@link ICalAttendee}.
      *
      * ```javascript
      * const cal = ical();
@@ -226,7 +226,7 @@ declare class ICalAttendee {
     /**
      * 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 [[`ICalAttendee`]].
+     * is not already an {@link ICalAttendee}.
      *
      * ```javascript
      * const cal = ical();
@@ -455,7 +455,7 @@ interface ICalAlarmJSONData {
     }[];
 }
 /**
- * Usually you get an `ICalAlarm` object like this:
+ * Usually you get an {@link ICalAlarm} object like this:
  *
  * ```javascript
  * import ical from 'ical-generator';
@@ -464,7 +464,7 @@ interface ICalAlarmJSONData {
  * const alarm = event.createAlarm();
  * ```
  *
- * You can also use the [[`ICalAlarm`]] object directly:
+ * You can also use the {@link ICalAlarm} object directly:
  *
  * ```javascript
  * import ical, {ICalAlarm} from 'ical-generator';
@@ -476,11 +476,11 @@ declare class ICalAlarm {
     private readonly data;
     private readonly event;
     /**
-     * Constructor of [[`ICalAttendee`]]. The event reference is required
+     * Constructor of {@link ICalAttendee}. The event reference is required
      * to query the calendar's timezone and summary when required.
      *
      * @param data Alarm Data
-     * @param calendar Reference to ICalEvent object
+     * @param event Reference to ICalEvent object
      */
     constructor(data: ICalAlarmData, event: ICalEvent);
     /**
@@ -489,14 +489,14 @@ declare class ICalAlarm {
      */
     type(type: ICalAlarmType): this;
     /**
-     * Set the alarm type. See [[`ICalAlarmType`]]
+     * Set the alarm type. See {@link ICalAlarmType}
      * for available status options.
      * @since 0.2.1
      */
     type(): ICalAlarmType;
     /**
      * Get the trigger time for the alarm. Can either
-     * be a date and time value ([[`ICalDateTimeValue`]]) or
+     * 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.
@@ -556,7 +556,7 @@ declare class ICalAlarm {
     relatesTo(relatesTo: ICalAlarmRelatesTo | null): this;
     /**
      * Get the trigger time for the alarm. Can either
-     * be a date and time value ([[`ICalDateTimeValue`]]) or
+     * 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.
@@ -585,7 +585,7 @@ declare class ICalAlarm {
     triggerAfter(trigger: number | ICalDateTimeValue): this;
     /**
      * Get the trigger time for the alarm. Can either
-     * be a date and time value ([[`ICalDateTimeValue`]]) or
+     * 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.
@@ -758,12 +758,12 @@ declare class ICalAlarm {
 interface ICalCategoryData {
     name: string;
 }
-interface ICalCategoryInternalData {
+interface ICalCategoryJSONData {
     name: string;
 }
-type ICalCategoryJSONData = ICalCategoryInternalData;
+type ICalCategoryInternalData = ICalCategoryJSONData;
 /**
- * Usually you get an `ICalCategory` object like this:
+ * Usually you get an {@link ICalCategory} object like this:
  *
  * ```javascript
  * import ical from 'ical-generator';
@@ -772,7 +772,7 @@ type ICalCategoryJSONData = ICalCategoryInternalData;
  * const category = event.createCategory();
  * ```
  *
- * You can also use the [[`ICalCategory`]] object directly:
+ * You can also use the {@link ICalCategory} object directly:
  *
  * ```javascript
  * import ical, {ICalCategory} from 'ical-generator';
@@ -783,7 +783,7 @@ type ICalCategoryJSONData = ICalCategoryInternalData;
 declare class ICalCategory {
     private readonly data;
     /**
-     * Constructor of [[`ICalCategory`]].
+     * Constructor of {@link ICalCategory}.
      * @param data Category Data
      */
     constructor(data: ICalCategoryData);
@@ -876,7 +876,7 @@ interface ICalEventJSONData {
     stamp: string;
     allDay: boolean;
     floating: boolean;
-    repeating: ICalEventInternalRepeatingData | string | null;
+    repeating: ICalEventJSONRepeatingData | string | null;
     summary: string;
     location: ICalLocation | null;
     description: ICalDescription | null;
@@ -897,7 +897,7 @@ interface ICalEventJSONData {
         value: string;
     }[];
 }
-interface ICalEventInternalRepeatingData {
+interface ICalEventJSONRepeatingData {
     freq: ICalEventRepeatingFreq;
     count?: number;
     interval?: number;
@@ -910,7 +910,7 @@ interface ICalEventInternalRepeatingData {
     startOfWeek?: ICalWeekday;
 }
 /**
- * Usually you get an `ICalEvent` object like this:
+ * Usually you get an {@link ICalEvent} object like this:
  * ```javascript
  * import ical from 'ical-generator';
  * const calendar = ical();
@@ -982,6 +982,35 @@ declare class ICalEvent {
      * [Readme](https://github.com/sebbo2002/ical-generator#-date-time--timezones)
      * for details about supported values and timezone handling.
      *
+     * ```typescript
+     * import ical from 'ical-generator';
+     *
+     * const cal = ical();
+     *
+     * const event = cal.createEvent({
+     *   start: new Date('2020-01-01')
+     * });
+     *
+     * // overwrites old start date
+     * event.start(new Date('2024-02-01'));
+     *
+     * cal.toString();
+     * ```
+     *
+     * ```text
+     * BEGIN:VCALENDAR
+     * VERSION:2.0
+     * PRODID:-//sebbo.net//ical-generator//EN
+     * BEGIN:VEVENT
+     * UID:7e2aee64-b07a-4256-9b3e-e9eaa452bac8
+     * SEQUENCE:0
+     * DTSTAMP:20240212T190915Z
+     * DTSTART:20240201T000000Z
+     * SUMMARY:
+     * END:VEVENT
+     * END:VCALENDAR
+     * ```
+     *
      * @since 0.2.0
      */
     start(start: ICalDateTimeValue): this;
@@ -1083,6 +1112,36 @@ declare class ICalEvent {
      * event.allDay(true); // → appointment is for the whole day
      * ```
      *
+     * ```typescript
+     * import ical from 'ical-generator';
+     *
+     * const cal = ical();
+     *
+     * cal.createEvent({
+     *   start: new Date('2020-01-01'),
+     *   summary: 'Very Important Day',
+     *   allDay: true
+     * });
+     *
+     * cal.toString();
+     * ```
+     *
+     * ```text
+     * BEGIN:VCALENDAR
+     * VERSION:2.0
+     * PRODID:-//sebbo.net//ical-generator//EN
+     * BEGIN:VEVENT
+     * UID:1964fe8d-32c5-4f2a-bd62-7d9d7de5992b
+     * SEQUENCE:0
+     * DTSTAMP:20240212T191956Z
+     * DTSTART;VALUE=DATE:20200101
+     * X-MICROSOFT-CDO-ALLDAYEVENT:TRUE
+     * X-MICROSOFT-MSNCALENDAR-ALLDAYEVENT:TRUE
+     * SUMMARY:Very Important Day
+     * END:VEVENT
+     * END:VCALENDAR
+     * ```
+     *
      * @since 0.2.0
      */
     allDay(allDay: boolean): this;
@@ -1096,9 +1155,9 @@ declare class ICalEvent {
      * Get the event's repeating options
      * @since 0.2.0
      */
-    repeating(): ICalEventInternalRepeatingData | ICalRRuleStub | string | null;
+    repeating(): ICalEventJSONRepeatingData | ICalRRuleStub | string | null;
     /**
-     * Set the event's repeating options by passing an [[`ICalRepeatingOptions`]] object.
+     * Set the event's repeating options by passing an {@link ICalRepeatingOptions} object.
      *
      * ```javascript
      * event.repeating({
@@ -1116,12 +1175,84 @@ declare class ICalEvent {
      * });
      * ```
      *
+     * **Example:**
+     *
+     *```typescript
+     * import ical, { ICalEventRepeatingFreq } from 'ical-generator';
+     *
+     * const cal = ical();
+     *
+     * const event = cal.createEvent({
+     *   start: new Date('2020-01-01T20:00:00Z'),
+     *   summary: 'Repeating Event'
+     * });
+     * event.repeating({
+     *   freq: ICalEventRepeatingFreq.WEEKLY,
+     *   count: 4
+     * });
+     *
+     * cal.toString();
+     * ```
+     *
+     * ```text
+     * BEGIN:VCALENDAR
+     * VERSION:2.0
+     * PRODID:-//sebbo.net//ical-generator//EN
+     * BEGIN:VEVENT
+     * UID:b80e6a68-c2cd-48f5-b94d-cecc7ce83871
+     * SEQUENCE:0
+     * DTSTAMP:20240212T193646Z
+     * DTSTART:20200101T200000Z
+     * RRULE:FREQ=WEEKLY;COUNT=4
+     * SUMMARY:Repeating Event
+     * END:VEVENT
+     * END:VCALENDAR
+     * ```
+     *
      * @since 0.2.0
      */
     repeating(repeating: ICalRepeatingOptions | null): this;
     /**
      * Set the event's repeating options by passing an [RRule object](https://github.com/jakubroztocil/rrule).
      * @since 2.0.0-develop.5
+     *
+     * ```typescript
+     * import ical from 'ical-generator';
+     * import { datetime, RRule } from 'rrule';
+     *
+     * const cal = ical();
+     *
+     * const event = cal.createEvent({
+     *   start: new Date('2020-01-01T20:00:00Z'),
+     *   summary: 'Repeating Event'
+     * });
+     *
+     * const rule = new RRule({
+     *   freq: RRule.WEEKLY,
+     *   interval: 5,
+     *   byweekday: [RRule.MO, RRule.FR],
+     *   dtstart: datetime(2012, 2, 1, 10, 30),
+     *   until: datetime(2012, 12, 31)
+     * })
+     * event.repeating(rule);
+     *
+     * cal.toString();
+     * ```
+     *
+     * ```text
+     * BEGIN:VCALENDAR
+     * VERSION:2.0
+     * PRODID:-//sebbo.net//ical-generator//EN
+     * BEGIN:VEVENT
+     * UID:36585e40-8fa8-460d-af0c-88b6f434030b
+     * SEQUENCE:0
+     * DTSTAMP:20240212T193827Z
+     * DTSTART:20200101T200000Z
+     * RRULE:FREQ=WEEKLY;INTERVAL=5;BYDAY=MO,FR;UNTIL=20121231T000000Z
+     * SUMMARY:Repeating Event
+     * END:VEVENT
+     * END:VCALENDAR
+     * ```
      */
     repeating(repeating: ICalRRuleStub | null): this;
     /**
@@ -1152,7 +1283,7 @@ declare class ICalEvent {
     location(): ICalLocation | null;
     /**
      * Set the event's location by passing a string (minimum) or
-     * an [[`ICalLocation`]] object which will also fill the iCal
+     * an {@link ICalLocation} object which will also fill the iCal
      * `GEO` attribute and Apple's `X-APPLE-STRUCTURED-LOCATION`.
      *
      * ```javascript
@@ -1167,11 +1298,20 @@ declare class ICalEvent {
      * });
      * ```
      *
+     * ```text
+     * LOCATION:Apple Store Kurfürstendamm\nKurfürstendamm 26\, 10719 Berlin\,
+     *  Deutschland
+     * X-APPLE-STRUCTURED-LOCATION;VALUE=URI;X-ADDRESS=Kurfürstendamm 26\, 10719
+     *   Berlin\, Deutschland;X-APPLE-RADIUS=141.1751386318387;X-TITLE=Apple Store
+     *   Kurfürstendamm:geo:52.50363,13.32865
+     * GEO:52.50363;13.32865
+     * ```
+     *
      * @since 0.2.0
      */
     location(location: ICalLocation | string | null): this;
     /**
-     * Get the event's description as an [[`ICalDescription`]] object.
+     * Get the event's description as an {@link ICalDescription} object.
      * @since 0.2.0
      */
     description(): ICalDescription | null;
@@ -1183,11 +1323,16 @@ declare class ICalEvent {
      *
      * ```javascript
      * event.description({
-     *     plain: 'Hello World!';
-     *     html: '<p>Hello World!</p>';
+     *     plain: 'Hello World!',
+     *     html: '<p>Hello World!</p>'
      * });
      * ```
      *
+     * ```text
+     * DESCRIPTION:Hello World!
+     * X-ALT-DESC;FMTTYPE=text/html:<p>Hello World!</p>
+     * ```
+     *
      * @since 0.2.0
      */
     description(description: ICalDescription | string | null): this;
@@ -1225,19 +1370,40 @@ declare class ICalEvent {
      */
     organizer(organizer: ICalOrganizer | string | null): this;
     /**
-     * Creates a new [[`ICalAttendee`]] and returns it. Use options to prefill
+     * 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.
      *
      * ```javascript
+     * import ical from 'ical-generator';
+     *
      * const cal = ical();
-     * const event = cal.createEvent();
-     * const attendee = event.createAttendee({email: 'hui@example.com', name: 'Hui'});
+     * const event = cal.createEvent({
+     *   start: new Date()
+     * });
+     *
+     * event.createAttendee({email: 'hui@example.com', name: 'Hui'});
      *
      * // add another attendee
      * event.createAttendee('Buh <buh@example.net>');
      * ```
      *
+     * ```text
+     * BEGIN:VCALENDAR
+     * VERSION:2.0
+     * PRODID:-//sebbo.net//ical-generator//EN
+     * BEGIN:VEVENT
+     * UID:b4944f07-98e4-4581-ac80-2589bb20273d
+     * SEQUENCE:0
+     * DTSTAMP:20240212T194232Z
+     * DTSTART:20240212T194232Z
+     * SUMMARY:
+     * ATTENDEE;ROLE=REQ-PARTICIPANT;CN="Hui":MAILTO:hui@example.com
+     * ATTENDEE;ROLE=REQ-PARTICIPANT;CN="Buh":MAILTO:buh@example.net
+     * END:VEVENT
+     * END:VCALENDAR
+     * ```
+     *
      * As with the organizer, you can also add an explicit `mailto` address.
      *
      * ```javascript
@@ -1273,7 +1439,7 @@ declare class ICalEvent {
      */
     attendees(attendees: (ICalAttendee | ICalAttendeeData | string)[]): this;
     /**
-     * Creates a new [[`ICalAlarm`]] and returns it. Use options to prefill
+     * Creates a new {@link ICalAlarm} and returns it. Use options to prefill
      * the alarm's attributes. Calling this method without options will create
      * an empty alarm.
      *
@@ -1315,7 +1481,7 @@ declare class ICalEvent {
      */
     alarms(alarms: ICalAlarm[] | ICalAlarmData[]): this;
     /**
-     * Creates a new [[`ICalCategory`]] and returns it. Use options to prefill the category's attributes.
+     * Creates a new {@link ICalCategory} and returns it. Use options to prefill the category's attributes.
      * Calling this method without options will create an empty category.
      *
      * ```javascript
@@ -1633,7 +1799,7 @@ declare enum ICalCalendarMethod {
     DECLINECOUNTER = "DECLINECOUNTER"
 }
 /**
- * Usually you get an `ICalCalendar` object like this:
+ * Usually you get an {@link ICalCalendar} object like this:
  * ```javascript
  * import ical from 'ical-generator';
  * const calendar = ical();
@@ -1648,7 +1814,7 @@ declare enum ICalCalendarMethod {
 declare class ICalCalendar {
     private readonly data;
     /**
-     * You can pass options to setup your calendar or use setters to do this.
+     * You can pass options to set up your calendar or use setters to do this.
      *
      * ```javascript
      *  * import ical from 'ical-generator';
@@ -1669,6 +1835,16 @@ declare class ICalCalendar {
      * cal.name('sebbo.net');
      * ```
      *
+     * `cal.toString()` would then produce the following string:
+     * ```text
+     * BEGIN:VCALENDAR
+     * VERSION:2.0
+     * PRODID:-//sebbo.net//ical-generator//EN
+     * NAME:sebbo.net
+     * X-WR-CALNAME:sebbo.net
+     * END:VCALENDAR
+     * ```
+     *
      * @param data Calendar data
      */
     constructor(data?: ICalCalendarData);
@@ -1680,7 +1856,7 @@ declare class ICalCalendar {
     /**
      * Set your feed's prodid. `prodid` can be either a
      * string like `//sebbo.net//ical-generator//EN` or a
-     * valid [[`ICalCalendarProdIdData`]] object. `language`
+     * valid {@link ICalCalendarProdIdData} object. `language`
      * is optional and defaults to `EN`.
      *
      * ```javascript
@@ -1691,23 +1867,30 @@ declare class ICalCalendar {
      * });
      * ```
      *
+     * `cal.toString()` would then produce the following string:
+     * ```text
+     * PRODID:-//My Company//My Product//EN
+     * ```
+     *
      * @since 0.2.0
      */
     prodId(prodId: ICalCalendarProdIdData | string): this;
     /**
      * Get the feed method attribute.
-     * See [[`ICalCalendarMethod`]] for possible results.
+     * See {@link ICalCalendarMethod} for possible results.
      *
      * @since 0.2.8
      */
     method(): ICalCalendarMethod | null;
     /**
      * Set the feed method attribute.
-     * See [[`ICalCalendarMethod`]] for available options.
+     * See {@link ICalCalendarMethod} for available options.
      *
      * #### Typescript Example
      * ```typescript
      * import {ICalCalendarMethod} from 'ical-generator';
+     *
+     * // METHOD:PUBLISH
      * calendar.method(ICalCalendarMethod.PUBLISH);
      * ```
      *
@@ -1723,6 +1906,24 @@ declare class ICalCalendar {
      * Set your feed's name. Is used to fill `NAME`
      * and `X-WR-CALNAME` in your iCal file.
      *
+     * ```typescript
+     * import ical from 'ical-generator';
+     *
+     * const cal = ical();
+     * cal.name('Next Arrivals');
+     *
+     * cal.toString();
+     * ```
+     *
+     * ```text
+     * BEGIN:VCALENDAR
+     * VERSION:2.0
+     * PRODID:-//sebbo.net//ical-generator//EN
+     * NAME:Next Arrivals
+     * X-WR-CALNAME:Next Arrivals
+     * END:VCALENDAR
+     * ```
+     *
      * @since 0.2.0
      */
     name(name: string | null): this;
@@ -1745,7 +1946,7 @@ declare class ICalCalendar {
      * Use this method to set your feed's timezone. Is used
      * to fill `TIMEZONE-ID` and `X-WR-TIMEZONE` in your iCal export.
      * Please not that all date values are treaded differently, if
-     * a timezone was set. See [[`formatDate`]] for details. If no
+     * a timezone was set. See {@link formatDate} for details. If no
      * time zone is specified, all information is output as UTC.
      *
      * ```javascript
@@ -1776,7 +1977,7 @@ declare class ICalCalendar {
      * import ical from 'ical-generator';
      * import {getVtimezoneComponent} from '@touch4it/ical-timezones';
      *
-     * const cal = new ICalCalendar();
+     * const cal = ical();
      * cal.timezone({
      *     name: 'FOO',
      *     generator: getVtimezoneComponent
@@ -1804,6 +2005,10 @@ declare class ICalCalendar {
      * cal.source('http://example.com/my/original_source.ical');
      * ```
      *
+     * ```text
+     * SOURCE;VALUE=URI:http://example.com/my/original_source.ical
+     * ```
+     *
      * @since 2.2.0-develop.1
      */
     source(source: string | null): this;
@@ -1864,7 +2069,7 @@ declare class ICalCalendar {
      */
     ttl(ttl: number | ICalMomentDurationStub | null): this;
     /**
-     * Creates a new [[`ICalEvent`]] and returns it. Use options to prefill the event's attributes.
+     * Creates a new {@link ICalEvent} and returns it. Use options to prefill the event's attributes.
      * Calling this method without options will create an empty event.
      *
      * ```javascript
@@ -1956,6 +2161,14 @@ declare class ICalCalendar {
      * });
      * ```
      *
+     * ```text
+     * BEGIN:VCALENDAR
+     * VERSION:2.0
+     * PRODID:-//sebbo.net//ical-generator//EN
+     * X-MY-CUSTOM-ATTR:1337!
+     * END:VCALENDAR
+     * ```
+     *
      * @since 1.9.0
      */
     x(keyOrArray: {
@@ -1971,6 +2184,14 @@ declare class ICalCalendar {
      * calendar.x("X-MY-CUSTOM-ATTR", "1337!");
      * ```
      *
+     * ```text
+     * BEGIN:VCALENDAR
+     * VERSION:2.0
+     * PRODID:-//sebbo.net//ical-generator//EN
+     * X-MY-CUSTOM-ATTR:1337!
+     * END:VCALENDAR
+     * ```
+     *
      * @since 1.9.0
      */
     x(keyOrArray: string, value: string): this;
@@ -2074,4 +2295,4 @@ declare function foldLines(input: string): string;
  */
 declare function ical(data?: ICalCalendarData): ICalCalendar;
 
-export { ICalAlarm, type ICalAlarmData, type ICalAlarmJSONData, type ICalAlarmRepeatData, ICalAlarmType, type ICalAlarmTypeValue, type ICalAttachment, ICalAttendee, type ICalAttendeeData, type ICalAttendeeJSONData, ICalAttendeeRole, ICalAttendeeStatus, ICalAttendeeType, ICalCalendar, type ICalCalendarData, type ICalCalendarJSONData, ICalCalendarMethod, type ICalCalendarProdIdData, ICalCategory, type ICalCategoryData, type ICalCategoryJSONData, type ICalDateTimeValue, type ICalDayJsStub, type ICalDescription, ICalEvent, ICalEventBusyStatus, ICalEventClass, type ICalEventData, type ICalEventJSONData, ICalEventRepeatingFreq, ICalEventStatus, ICalEventTransparency, type ICalGeo, type ICalLocation, type ICalLuxonDateTimeStub, type ICalMomentDurationStub, type ICalMomentStub, type ICalMomentTimezoneStub, type ICalOrganizer, type ICalRRuleStub, type ICalRepeatingOptions, type ICalTimezone, ICalWeekday, ical as default, escape, foldLines, formatDate, formatDateTZ };
+export { ICalAlarm, type ICalAlarmBaseData, type ICalAlarmData, type ICalAlarmJSONData, ICalAlarmRelatesTo, type ICalAlarmRepeatData, type ICalAlarmTriggerAfterData, type ICalAlarmTriggerBeforeData, type ICalAlarmTriggerData, ICalAlarmType, type ICalAlarmTypeValue, type ICalAttachment, ICalAttendee, type ICalAttendeeData, type ICalAttendeeJSONData, ICalAttendeeRole, ICalAttendeeStatus, ICalAttendeeType, ICalCalendar, type ICalCalendarData, type ICalCalendarJSONData, ICalCalendarMethod, type ICalCalendarProdIdData, ICalCategory, type ICalCategoryData, type ICalCategoryJSONData, type ICalDateTimeValue, type ICalDayJsStub, type ICalDescription, ICalEvent, ICalEventBusyStatus, ICalEventClass, type ICalEventData, type ICalEventJSONData, type ICalEventJSONRepeatingData, ICalEventRepeatingFreq, ICalEventStatus, ICalEventTransparency, type ICalGeo, type ICalLocation, type ICalLuxonDateTimeStub, type ICalMomentDurationStub, type ICalMomentStub, type ICalMomentTimezoneStub, type ICalOrganizer, type ICalRRuleStub, type ICalRepeatingOptions, type ICalTimezone, ICalWeekday, ical as default, escape, foldLines, formatDate, formatDateTZ };