ical-generator 6.0.2-develop.7 → 6.0.2-develop.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.cts CHANGED
@@ -53,7 +53,7 @@ declare enum ICalAttendeeType {
53
53
  UNKNOWN = "UNKNOWN"
54
54
  }
55
55
  /**
56
- * Usually you get an `ICalAttendee` object like this:
56
+ * Usually you get an {@link ICalAttendee} object like this:
57
57
  *
58
58
  * ```javascript
59
59
  * import ical from 'ical-generator';
@@ -62,7 +62,7 @@ declare enum ICalAttendeeType {
62
62
  * const attendee = event.createAttendee({ email: 'mail@example.com' });
63
63
  * ```
64
64
  *
65
- * You can also use the [[`ICalAttendee`]] object directly:
65
+ * You can also use the {@link ICalAttendee} object directly:
66
66
  *
67
67
  * ```javascript
68
68
  * import ical, {ICalAttendee} from 'ical-generator';
@@ -74,11 +74,11 @@ declare class ICalAttendee {
74
74
  private readonly data;
75
75
  private readonly event;
76
76
  /**
77
- * Constructor of [[`ICalAttendee`]]. The event reference is
77
+ * Constructor of {@link ICalAttendee}. The event reference is
78
78
  * required to query the calendar's timezone when required.
79
79
  *
80
80
  * @param data Attendee Data
81
- * @param calendar Reference to ICalEvent object
81
+ * @param event Reference to ICalEvent object
82
82
  */
83
83
  constructor(data: ICalAttendeeData, event: ICalEvent);
84
84
  /**
@@ -128,7 +128,7 @@ declare class ICalAttendee {
128
128
  role(): ICalAttendeeRole;
129
129
  /**
130
130
  * Set the attendee's role, defaults to `REQ` / `REQ-PARTICIPANT`.
131
- * Checkout [[`ICalAttendeeRole`]] for available roles.
131
+ * Checkout {@link ICalAttendeeRole} for available roles.
132
132
  *
133
133
  * @since 0.2.0
134
134
  */
@@ -149,7 +149,7 @@ declare class ICalAttendee {
149
149
  */
150
150
  status(): ICalAttendeeStatus | null;
151
151
  /**
152
- * Set the attendee's status. See [[`ICalAttendeeStatus`]]
152
+ * Set the attendee's status. See {@link ICalAttendeeStatus}
153
153
  * for available status options.
154
154
  *
155
155
  * @since 0.2.0
@@ -162,7 +162,7 @@ declare class ICalAttendee {
162
162
  type(): ICalAttendeeType;
163
163
  /**
164
164
  * Set attendee's type (a.k.a. CUTYPE).
165
- * See [[`ICalAttendeeType`]] for available status options.
165
+ * See {@link ICalAttendeeType} for available status options.
166
166
  *
167
167
  * @since 0.2.3
168
168
  */
@@ -176,7 +176,7 @@ declare class ICalAttendee {
176
176
  * Set the attendee's delegated-to field.
177
177
  *
178
178
  * Creates a new Attendee if the passed object is not already a
179
- * [[`ICalAttendee`]] object. Will set the `delegatedTo` and
179
+ * {@link ICalAttendee} object. Will set the `delegatedTo` and
180
180
  * `delegatedFrom` attributes.
181
181
  *
182
182
  * Will also set the `status` to `DELEGATED`, if attribute is set.
@@ -201,7 +201,7 @@ declare class ICalAttendee {
201
201
  * Set the attendee's delegated-from field
202
202
  *
203
203
  * Creates a new Attendee if the passed object is not already a
204
- * [[`ICalAttendee`]] object. Will set the `delegatedTo` and
204
+ * {@link ICalAttendee} object. Will set the `delegatedTo` and
205
205
  * `delegatedFrom` attributes.
206
206
  *
207
207
  * @param delegatedFrom
@@ -210,7 +210,7 @@ declare class ICalAttendee {
210
210
  /**
211
211
  * Create a new attendee this attendee delegates to and returns
212
212
  * this new attendee. Creates a new attendee if the passed object
213
- * is not already an [[`ICalAttendee`]].
213
+ * is not already an {@link ICalAttendee}.
214
214
  *
215
215
  * ```javascript
216
216
  * const cal = ical();
@@ -226,7 +226,7 @@ declare class ICalAttendee {
226
226
  /**
227
227
  * Create a new attendee this attendee delegates from and returns
228
228
  * this new attendee. Creates a new attendee if the passed object
229
- * is not already an [[`ICalAttendee`]].
229
+ * is not already an {@link ICalAttendee}.
230
230
  *
231
231
  * ```javascript
232
232
  * const cal = ical();
@@ -455,7 +455,7 @@ interface ICalAlarmJSONData {
455
455
  }[];
456
456
  }
457
457
  /**
458
- * Usually you get an `ICalAlarm` object like this:
458
+ * Usually you get an {@link ICalAlarm} object like this:
459
459
  *
460
460
  * ```javascript
461
461
  * import ical from 'ical-generator';
@@ -464,7 +464,7 @@ interface ICalAlarmJSONData {
464
464
  * const alarm = event.createAlarm();
465
465
  * ```
466
466
  *
467
- * You can also use the [[`ICalAlarm`]] object directly:
467
+ * You can also use the {@link ICalAlarm} object directly:
468
468
  *
469
469
  * ```javascript
470
470
  * import ical, {ICalAlarm} from 'ical-generator';
@@ -476,11 +476,11 @@ declare class ICalAlarm {
476
476
  private readonly data;
477
477
  private readonly event;
478
478
  /**
479
- * Constructor of [[`ICalAttendee`]]. The event reference is required
479
+ * Constructor of {@link ICalAttendee}. The event reference is required
480
480
  * to query the calendar's timezone and summary when required.
481
481
  *
482
482
  * @param data Alarm Data
483
- * @param calendar Reference to ICalEvent object
483
+ * @param event Reference to ICalEvent object
484
484
  */
485
485
  constructor(data: ICalAlarmData, event: ICalEvent);
486
486
  /**
@@ -489,14 +489,14 @@ declare class ICalAlarm {
489
489
  */
490
490
  type(type: ICalAlarmType): this;
491
491
  /**
492
- * Set the alarm type. See [[`ICalAlarmType`]]
492
+ * Set the alarm type. See {@link ICalAlarmType}
493
493
  * for available status options.
494
494
  * @since 0.2.1
495
495
  */
496
496
  type(): ICalAlarmType;
497
497
  /**
498
498
  * Get the trigger time for the alarm. Can either
499
- * be a date and time value ([[`ICalDateTimeValue`]]) or
499
+ * be a date and time value ({@link ICalDateTimeValue}) or
500
500
  * a number, which will represent the seconds between
501
501
  * alarm and event start. The number is negative, if the
502
502
  * alarm is triggered after the event started.
@@ -556,7 +556,7 @@ declare class ICalAlarm {
556
556
  relatesTo(relatesTo: ICalAlarmRelatesTo | null): this;
557
557
  /**
558
558
  * Get the trigger time for the alarm. Can either
559
- * be a date and time value ([[`ICalDateTimeValue`]]) or
559
+ * be a date and time value ({@link ICalDateTimeValue}) or
560
560
  * a number, which will represent the seconds between
561
561
  * alarm and event start. The number is negative, if the
562
562
  * alarm is triggered before the event started.
@@ -585,7 +585,7 @@ declare class ICalAlarm {
585
585
  triggerAfter(trigger: number | ICalDateTimeValue): this;
586
586
  /**
587
587
  * Get the trigger time for the alarm. Can either
588
- * be a date and time value ([[`ICalDateTimeValue`]]) or
588
+ * be a date and time value ({@link ICalDateTimeValue}) or
589
589
  * a number, which will represent the seconds between
590
590
  * alarm and event start. The number is negative, if the
591
591
  * alarm is triggered after the event started.
@@ -758,12 +758,12 @@ declare class ICalAlarm {
758
758
  interface ICalCategoryData {
759
759
  name: string;
760
760
  }
761
- interface ICalCategoryInternalData {
761
+ interface ICalCategoryJSONData {
762
762
  name: string;
763
763
  }
764
- type ICalCategoryJSONData = ICalCategoryInternalData;
764
+ type ICalCategoryInternalData = ICalCategoryJSONData;
765
765
  /**
766
- * Usually you get an `ICalCategory` object like this:
766
+ * Usually you get an {@link ICalCategory} object like this:
767
767
  *
768
768
  * ```javascript
769
769
  * import ical from 'ical-generator';
@@ -772,7 +772,7 @@ type ICalCategoryJSONData = ICalCategoryInternalData;
772
772
  * const category = event.createCategory();
773
773
  * ```
774
774
  *
775
- * You can also use the [[`ICalCategory`]] object directly:
775
+ * You can also use the {@link ICalCategory} object directly:
776
776
  *
777
777
  * ```javascript
778
778
  * import ical, {ICalCategory} from 'ical-generator';
@@ -783,7 +783,7 @@ type ICalCategoryJSONData = ICalCategoryInternalData;
783
783
  declare class ICalCategory {
784
784
  private readonly data;
785
785
  /**
786
- * Constructor of [[`ICalCategory`]].
786
+ * Constructor of {@link ICalCategory}.
787
787
  * @param data Category Data
788
788
  */
789
789
  constructor(data: ICalCategoryData);
@@ -876,7 +876,7 @@ interface ICalEventJSONData {
876
876
  stamp: string;
877
877
  allDay: boolean;
878
878
  floating: boolean;
879
- repeating: ICalEventInternalRepeatingData | string | null;
879
+ repeating: ICalEventJSONRepeatingData | string | null;
880
880
  summary: string;
881
881
  location: ICalLocation | null;
882
882
  description: ICalDescription | null;
@@ -897,7 +897,7 @@ interface ICalEventJSONData {
897
897
  value: string;
898
898
  }[];
899
899
  }
900
- interface ICalEventInternalRepeatingData {
900
+ interface ICalEventJSONRepeatingData {
901
901
  freq: ICalEventRepeatingFreq;
902
902
  count?: number;
903
903
  interval?: number;
@@ -910,7 +910,7 @@ interface ICalEventInternalRepeatingData {
910
910
  startOfWeek?: ICalWeekday;
911
911
  }
912
912
  /**
913
- * Usually you get an `ICalEvent` object like this:
913
+ * Usually you get an {@link ICalEvent} object like this:
914
914
  * ```javascript
915
915
  * import ical from 'ical-generator';
916
916
  * const calendar = ical();
@@ -1155,9 +1155,9 @@ declare class ICalEvent {
1155
1155
  * Get the event's repeating options
1156
1156
  * @since 0.2.0
1157
1157
  */
1158
- repeating(): ICalEventInternalRepeatingData | ICalRRuleStub | string | null;
1158
+ repeating(): ICalEventJSONRepeatingData | ICalRRuleStub | string | null;
1159
1159
  /**
1160
- * Set the event's repeating options by passing an [[`ICalRepeatingOptions`]] object.
1160
+ * Set the event's repeating options by passing an {@link ICalRepeatingOptions} object.
1161
1161
  *
1162
1162
  * ```javascript
1163
1163
  * event.repeating({
@@ -1283,7 +1283,7 @@ declare class ICalEvent {
1283
1283
  location(): ICalLocation | null;
1284
1284
  /**
1285
1285
  * Set the event's location by passing a string (minimum) or
1286
- * an [[`ICalLocation`]] object which will also fill the iCal
1286
+ * an {@link ICalLocation} object which will also fill the iCal
1287
1287
  * `GEO` attribute and Apple's `X-APPLE-STRUCTURED-LOCATION`.
1288
1288
  *
1289
1289
  * ```javascript
@@ -1311,7 +1311,7 @@ declare class ICalEvent {
1311
1311
  */
1312
1312
  location(location: ICalLocation | string | null): this;
1313
1313
  /**
1314
- * Get the event's description as an [[`ICalDescription`]] object.
1314
+ * Get the event's description as an {@link ICalDescription} object.
1315
1315
  * @since 0.2.0
1316
1316
  */
1317
1317
  description(): ICalDescription | null;
@@ -1370,7 +1370,7 @@ declare class ICalEvent {
1370
1370
  */
1371
1371
  organizer(organizer: ICalOrganizer | string | null): this;
1372
1372
  /**
1373
- * Creates a new [[`ICalAttendee`]] and returns it. Use options to prefill
1373
+ * Creates a new {@link ICalAttendee} and returns it. Use options to prefill
1374
1374
  * the attendee's attributes. Calling this method without options will create
1375
1375
  * an empty attendee.
1376
1376
  *
@@ -1439,7 +1439,7 @@ declare class ICalEvent {
1439
1439
  */
1440
1440
  attendees(attendees: (ICalAttendee | ICalAttendeeData | string)[]): this;
1441
1441
  /**
1442
- * Creates a new [[`ICalAlarm`]] and returns it. Use options to prefill
1442
+ * Creates a new {@link ICalAlarm} and returns it. Use options to prefill
1443
1443
  * the alarm's attributes. Calling this method without options will create
1444
1444
  * an empty alarm.
1445
1445
  *
@@ -1481,7 +1481,7 @@ declare class ICalEvent {
1481
1481
  */
1482
1482
  alarms(alarms: ICalAlarm[] | ICalAlarmData[]): this;
1483
1483
  /**
1484
- * Creates a new [[`ICalCategory`]] and returns it. Use options to prefill the category's attributes.
1484
+ * Creates a new {@link ICalCategory} and returns it. Use options to prefill the category's attributes.
1485
1485
  * Calling this method without options will create an empty category.
1486
1486
  *
1487
1487
  * ```javascript
@@ -1799,7 +1799,7 @@ declare enum ICalCalendarMethod {
1799
1799
  DECLINECOUNTER = "DECLINECOUNTER"
1800
1800
  }
1801
1801
  /**
1802
- * Usually you get an `ICalCalendar` object like this:
1802
+ * Usually you get an {@link ICalCalendar} object like this:
1803
1803
  * ```javascript
1804
1804
  * import ical from 'ical-generator';
1805
1805
  * const calendar = ical();
@@ -1856,7 +1856,7 @@ declare class ICalCalendar {
1856
1856
  /**
1857
1857
  * Set your feed's prodid. `prodid` can be either a
1858
1858
  * string like `//sebbo.net//ical-generator//EN` or a
1859
- * valid [[`ICalCalendarProdIdData`]] object. `language`
1859
+ * valid {@link ICalCalendarProdIdData} object. `language`
1860
1860
  * is optional and defaults to `EN`.
1861
1861
  *
1862
1862
  * ```javascript
@@ -1877,14 +1877,14 @@ declare class ICalCalendar {
1877
1877
  prodId(prodId: ICalCalendarProdIdData | string): this;
1878
1878
  /**
1879
1879
  * Get the feed method attribute.
1880
- * See [[`ICalCalendarMethod`]] for possible results.
1880
+ * See {@link ICalCalendarMethod} for possible results.
1881
1881
  *
1882
1882
  * @since 0.2.8
1883
1883
  */
1884
1884
  method(): ICalCalendarMethod | null;
1885
1885
  /**
1886
1886
  * Set the feed method attribute.
1887
- * See [[`ICalCalendarMethod`]] for available options.
1887
+ * See {@link ICalCalendarMethod} for available options.
1888
1888
  *
1889
1889
  * #### Typescript Example
1890
1890
  * ```typescript
@@ -1946,7 +1946,7 @@ declare class ICalCalendar {
1946
1946
  * Use this method to set your feed's timezone. Is used
1947
1947
  * to fill `TIMEZONE-ID` and `X-WR-TIMEZONE` in your iCal export.
1948
1948
  * Please not that all date values are treaded differently, if
1949
- * a timezone was set. See [[`formatDate`]] for details. If no
1949
+ * a timezone was set. See {@link formatDate} for details. If no
1950
1950
  * time zone is specified, all information is output as UTC.
1951
1951
  *
1952
1952
  * ```javascript
@@ -2069,7 +2069,7 @@ declare class ICalCalendar {
2069
2069
  */
2070
2070
  ttl(ttl: number | ICalMomentDurationStub | null): this;
2071
2071
  /**
2072
- * Creates a new [[`ICalEvent`]] and returns it. Use options to prefill the event's attributes.
2072
+ * Creates a new {@link ICalEvent} and returns it. Use options to prefill the event's attributes.
2073
2073
  * Calling this method without options will create an empty event.
2074
2074
  *
2075
2075
  * ```javascript
@@ -2295,4 +2295,4 @@ declare function foldLines(input: string): string;
2295
2295
  */
2296
2296
  declare function ical(data?: ICalCalendarData): ICalCalendar;
2297
2297
 
2298
- 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 };
2298
+ 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 };
package/dist/index.d.ts CHANGED
@@ -53,7 +53,7 @@ declare enum ICalAttendeeType {
53
53
  UNKNOWN = "UNKNOWN"
54
54
  }
55
55
  /**
56
- * Usually you get an `ICalAttendee` object like this:
56
+ * Usually you get an {@link ICalAttendee} object like this:
57
57
  *
58
58
  * ```javascript
59
59
  * import ical from 'ical-generator';
@@ -62,7 +62,7 @@ declare enum ICalAttendeeType {
62
62
  * const attendee = event.createAttendee({ email: 'mail@example.com' });
63
63
  * ```
64
64
  *
65
- * You can also use the [[`ICalAttendee`]] object directly:
65
+ * You can also use the {@link ICalAttendee} object directly:
66
66
  *
67
67
  * ```javascript
68
68
  * import ical, {ICalAttendee} from 'ical-generator';
@@ -74,11 +74,11 @@ declare class ICalAttendee {
74
74
  private readonly data;
75
75
  private readonly event;
76
76
  /**
77
- * Constructor of [[`ICalAttendee`]]. The event reference is
77
+ * Constructor of {@link ICalAttendee}. The event reference is
78
78
  * required to query the calendar's timezone when required.
79
79
  *
80
80
  * @param data Attendee Data
81
- * @param calendar Reference to ICalEvent object
81
+ * @param event Reference to ICalEvent object
82
82
  */
83
83
  constructor(data: ICalAttendeeData, event: ICalEvent);
84
84
  /**
@@ -128,7 +128,7 @@ declare class ICalAttendee {
128
128
  role(): ICalAttendeeRole;
129
129
  /**
130
130
  * Set the attendee's role, defaults to `REQ` / `REQ-PARTICIPANT`.
131
- * Checkout [[`ICalAttendeeRole`]] for available roles.
131
+ * Checkout {@link ICalAttendeeRole} for available roles.
132
132
  *
133
133
  * @since 0.2.0
134
134
  */
@@ -149,7 +149,7 @@ declare class ICalAttendee {
149
149
  */
150
150
  status(): ICalAttendeeStatus | null;
151
151
  /**
152
- * Set the attendee's status. See [[`ICalAttendeeStatus`]]
152
+ * Set the attendee's status. See {@link ICalAttendeeStatus}
153
153
  * for available status options.
154
154
  *
155
155
  * @since 0.2.0
@@ -162,7 +162,7 @@ declare class ICalAttendee {
162
162
  type(): ICalAttendeeType;
163
163
  /**
164
164
  * Set attendee's type (a.k.a. CUTYPE).
165
- * See [[`ICalAttendeeType`]] for available status options.
165
+ * See {@link ICalAttendeeType} for available status options.
166
166
  *
167
167
  * @since 0.2.3
168
168
  */
@@ -176,7 +176,7 @@ declare class ICalAttendee {
176
176
  * Set the attendee's delegated-to field.
177
177
  *
178
178
  * Creates a new Attendee if the passed object is not already a
179
- * [[`ICalAttendee`]] object. Will set the `delegatedTo` and
179
+ * {@link ICalAttendee} object. Will set the `delegatedTo` and
180
180
  * `delegatedFrom` attributes.
181
181
  *
182
182
  * Will also set the `status` to `DELEGATED`, if attribute is set.
@@ -201,7 +201,7 @@ declare class ICalAttendee {
201
201
  * Set the attendee's delegated-from field
202
202
  *
203
203
  * Creates a new Attendee if the passed object is not already a
204
- * [[`ICalAttendee`]] object. Will set the `delegatedTo` and
204
+ * {@link ICalAttendee} object. Will set the `delegatedTo` and
205
205
  * `delegatedFrom` attributes.
206
206
  *
207
207
  * @param delegatedFrom
@@ -210,7 +210,7 @@ declare class ICalAttendee {
210
210
  /**
211
211
  * Create a new attendee this attendee delegates to and returns
212
212
  * this new attendee. Creates a new attendee if the passed object
213
- * is not already an [[`ICalAttendee`]].
213
+ * is not already an {@link ICalAttendee}.
214
214
  *
215
215
  * ```javascript
216
216
  * const cal = ical();
@@ -226,7 +226,7 @@ declare class ICalAttendee {
226
226
  /**
227
227
  * Create a new attendee this attendee delegates from and returns
228
228
  * this new attendee. Creates a new attendee if the passed object
229
- * is not already an [[`ICalAttendee`]].
229
+ * is not already an {@link ICalAttendee}.
230
230
  *
231
231
  * ```javascript
232
232
  * const cal = ical();
@@ -455,7 +455,7 @@ interface ICalAlarmJSONData {
455
455
  }[];
456
456
  }
457
457
  /**
458
- * Usually you get an `ICalAlarm` object like this:
458
+ * Usually you get an {@link ICalAlarm} object like this:
459
459
  *
460
460
  * ```javascript
461
461
  * import ical from 'ical-generator';
@@ -464,7 +464,7 @@ interface ICalAlarmJSONData {
464
464
  * const alarm = event.createAlarm();
465
465
  * ```
466
466
  *
467
- * You can also use the [[`ICalAlarm`]] object directly:
467
+ * You can also use the {@link ICalAlarm} object directly:
468
468
  *
469
469
  * ```javascript
470
470
  * import ical, {ICalAlarm} from 'ical-generator';
@@ -476,11 +476,11 @@ declare class ICalAlarm {
476
476
  private readonly data;
477
477
  private readonly event;
478
478
  /**
479
- * Constructor of [[`ICalAttendee`]]. The event reference is required
479
+ * Constructor of {@link ICalAttendee}. The event reference is required
480
480
  * to query the calendar's timezone and summary when required.
481
481
  *
482
482
  * @param data Alarm Data
483
- * @param calendar Reference to ICalEvent object
483
+ * @param event Reference to ICalEvent object
484
484
  */
485
485
  constructor(data: ICalAlarmData, event: ICalEvent);
486
486
  /**
@@ -489,14 +489,14 @@ declare class ICalAlarm {
489
489
  */
490
490
  type(type: ICalAlarmType): this;
491
491
  /**
492
- * Set the alarm type. See [[`ICalAlarmType`]]
492
+ * Set the alarm type. See {@link ICalAlarmType}
493
493
  * for available status options.
494
494
  * @since 0.2.1
495
495
  */
496
496
  type(): ICalAlarmType;
497
497
  /**
498
498
  * Get the trigger time for the alarm. Can either
499
- * be a date and time value ([[`ICalDateTimeValue`]]) or
499
+ * be a date and time value ({@link ICalDateTimeValue}) or
500
500
  * a number, which will represent the seconds between
501
501
  * alarm and event start. The number is negative, if the
502
502
  * alarm is triggered after the event started.
@@ -556,7 +556,7 @@ declare class ICalAlarm {
556
556
  relatesTo(relatesTo: ICalAlarmRelatesTo | null): this;
557
557
  /**
558
558
  * Get the trigger time for the alarm. Can either
559
- * be a date and time value ([[`ICalDateTimeValue`]]) or
559
+ * be a date and time value ({@link ICalDateTimeValue}) or
560
560
  * a number, which will represent the seconds between
561
561
  * alarm and event start. The number is negative, if the
562
562
  * alarm is triggered before the event started.
@@ -585,7 +585,7 @@ declare class ICalAlarm {
585
585
  triggerAfter(trigger: number | ICalDateTimeValue): this;
586
586
  /**
587
587
  * Get the trigger time for the alarm. Can either
588
- * be a date and time value ([[`ICalDateTimeValue`]]) or
588
+ * be a date and time value ({@link ICalDateTimeValue}) or
589
589
  * a number, which will represent the seconds between
590
590
  * alarm and event start. The number is negative, if the
591
591
  * alarm is triggered after the event started.
@@ -758,12 +758,12 @@ declare class ICalAlarm {
758
758
  interface ICalCategoryData {
759
759
  name: string;
760
760
  }
761
- interface ICalCategoryInternalData {
761
+ interface ICalCategoryJSONData {
762
762
  name: string;
763
763
  }
764
- type ICalCategoryJSONData = ICalCategoryInternalData;
764
+ type ICalCategoryInternalData = ICalCategoryJSONData;
765
765
  /**
766
- * Usually you get an `ICalCategory` object like this:
766
+ * Usually you get an {@link ICalCategory} object like this:
767
767
  *
768
768
  * ```javascript
769
769
  * import ical from 'ical-generator';
@@ -772,7 +772,7 @@ type ICalCategoryJSONData = ICalCategoryInternalData;
772
772
  * const category = event.createCategory();
773
773
  * ```
774
774
  *
775
- * You can also use the [[`ICalCategory`]] object directly:
775
+ * You can also use the {@link ICalCategory} object directly:
776
776
  *
777
777
  * ```javascript
778
778
  * import ical, {ICalCategory} from 'ical-generator';
@@ -783,7 +783,7 @@ type ICalCategoryJSONData = ICalCategoryInternalData;
783
783
  declare class ICalCategory {
784
784
  private readonly data;
785
785
  /**
786
- * Constructor of [[`ICalCategory`]].
786
+ * Constructor of {@link ICalCategory}.
787
787
  * @param data Category Data
788
788
  */
789
789
  constructor(data: ICalCategoryData);
@@ -876,7 +876,7 @@ interface ICalEventJSONData {
876
876
  stamp: string;
877
877
  allDay: boolean;
878
878
  floating: boolean;
879
- repeating: ICalEventInternalRepeatingData | string | null;
879
+ repeating: ICalEventJSONRepeatingData | string | null;
880
880
  summary: string;
881
881
  location: ICalLocation | null;
882
882
  description: ICalDescription | null;
@@ -897,7 +897,7 @@ interface ICalEventJSONData {
897
897
  value: string;
898
898
  }[];
899
899
  }
900
- interface ICalEventInternalRepeatingData {
900
+ interface ICalEventJSONRepeatingData {
901
901
  freq: ICalEventRepeatingFreq;
902
902
  count?: number;
903
903
  interval?: number;
@@ -910,7 +910,7 @@ interface ICalEventInternalRepeatingData {
910
910
  startOfWeek?: ICalWeekday;
911
911
  }
912
912
  /**
913
- * Usually you get an `ICalEvent` object like this:
913
+ * Usually you get an {@link ICalEvent} object like this:
914
914
  * ```javascript
915
915
  * import ical from 'ical-generator';
916
916
  * const calendar = ical();
@@ -1155,9 +1155,9 @@ declare class ICalEvent {
1155
1155
  * Get the event's repeating options
1156
1156
  * @since 0.2.0
1157
1157
  */
1158
- repeating(): ICalEventInternalRepeatingData | ICalRRuleStub | string | null;
1158
+ repeating(): ICalEventJSONRepeatingData | ICalRRuleStub | string | null;
1159
1159
  /**
1160
- * Set the event's repeating options by passing an [[`ICalRepeatingOptions`]] object.
1160
+ * Set the event's repeating options by passing an {@link ICalRepeatingOptions} object.
1161
1161
  *
1162
1162
  * ```javascript
1163
1163
  * event.repeating({
@@ -1283,7 +1283,7 @@ declare class ICalEvent {
1283
1283
  location(): ICalLocation | null;
1284
1284
  /**
1285
1285
  * Set the event's location by passing a string (minimum) or
1286
- * an [[`ICalLocation`]] object which will also fill the iCal
1286
+ * an {@link ICalLocation} object which will also fill the iCal
1287
1287
  * `GEO` attribute and Apple's `X-APPLE-STRUCTURED-LOCATION`.
1288
1288
  *
1289
1289
  * ```javascript
@@ -1311,7 +1311,7 @@ declare class ICalEvent {
1311
1311
  */
1312
1312
  location(location: ICalLocation | string | null): this;
1313
1313
  /**
1314
- * Get the event's description as an [[`ICalDescription`]] object.
1314
+ * Get the event's description as an {@link ICalDescription} object.
1315
1315
  * @since 0.2.0
1316
1316
  */
1317
1317
  description(): ICalDescription | null;
@@ -1370,7 +1370,7 @@ declare class ICalEvent {
1370
1370
  */
1371
1371
  organizer(organizer: ICalOrganizer | string | null): this;
1372
1372
  /**
1373
- * Creates a new [[`ICalAttendee`]] and returns it. Use options to prefill
1373
+ * Creates a new {@link ICalAttendee} and returns it. Use options to prefill
1374
1374
  * the attendee's attributes. Calling this method without options will create
1375
1375
  * an empty attendee.
1376
1376
  *
@@ -1439,7 +1439,7 @@ declare class ICalEvent {
1439
1439
  */
1440
1440
  attendees(attendees: (ICalAttendee | ICalAttendeeData | string)[]): this;
1441
1441
  /**
1442
- * Creates a new [[`ICalAlarm`]] and returns it. Use options to prefill
1442
+ * Creates a new {@link ICalAlarm} and returns it. Use options to prefill
1443
1443
  * the alarm's attributes. Calling this method without options will create
1444
1444
  * an empty alarm.
1445
1445
  *
@@ -1481,7 +1481,7 @@ declare class ICalEvent {
1481
1481
  */
1482
1482
  alarms(alarms: ICalAlarm[] | ICalAlarmData[]): this;
1483
1483
  /**
1484
- * Creates a new [[`ICalCategory`]] and returns it. Use options to prefill the category's attributes.
1484
+ * Creates a new {@link ICalCategory} and returns it. Use options to prefill the category's attributes.
1485
1485
  * Calling this method without options will create an empty category.
1486
1486
  *
1487
1487
  * ```javascript
@@ -1799,7 +1799,7 @@ declare enum ICalCalendarMethod {
1799
1799
  DECLINECOUNTER = "DECLINECOUNTER"
1800
1800
  }
1801
1801
  /**
1802
- * Usually you get an `ICalCalendar` object like this:
1802
+ * Usually you get an {@link ICalCalendar} object like this:
1803
1803
  * ```javascript
1804
1804
  * import ical from 'ical-generator';
1805
1805
  * const calendar = ical();
@@ -1856,7 +1856,7 @@ declare class ICalCalendar {
1856
1856
  /**
1857
1857
  * Set your feed's prodid. `prodid` can be either a
1858
1858
  * string like `//sebbo.net//ical-generator//EN` or a
1859
- * valid [[`ICalCalendarProdIdData`]] object. `language`
1859
+ * valid {@link ICalCalendarProdIdData} object. `language`
1860
1860
  * is optional and defaults to `EN`.
1861
1861
  *
1862
1862
  * ```javascript
@@ -1877,14 +1877,14 @@ declare class ICalCalendar {
1877
1877
  prodId(prodId: ICalCalendarProdIdData | string): this;
1878
1878
  /**
1879
1879
  * Get the feed method attribute.
1880
- * See [[`ICalCalendarMethod`]] for possible results.
1880
+ * See {@link ICalCalendarMethod} for possible results.
1881
1881
  *
1882
1882
  * @since 0.2.8
1883
1883
  */
1884
1884
  method(): ICalCalendarMethod | null;
1885
1885
  /**
1886
1886
  * Set the feed method attribute.
1887
- * See [[`ICalCalendarMethod`]] for available options.
1887
+ * See {@link ICalCalendarMethod} for available options.
1888
1888
  *
1889
1889
  * #### Typescript Example
1890
1890
  * ```typescript
@@ -1946,7 +1946,7 @@ declare class ICalCalendar {
1946
1946
  * Use this method to set your feed's timezone. Is used
1947
1947
  * to fill `TIMEZONE-ID` and `X-WR-TIMEZONE` in your iCal export.
1948
1948
  * Please not that all date values are treaded differently, if
1949
- * a timezone was set. See [[`formatDate`]] for details. If no
1949
+ * a timezone was set. See {@link formatDate} for details. If no
1950
1950
  * time zone is specified, all information is output as UTC.
1951
1951
  *
1952
1952
  * ```javascript
@@ -2069,7 +2069,7 @@ declare class ICalCalendar {
2069
2069
  */
2070
2070
  ttl(ttl: number | ICalMomentDurationStub | null): this;
2071
2071
  /**
2072
- * Creates a new [[`ICalEvent`]] and returns it. Use options to prefill the event's attributes.
2072
+ * Creates a new {@link ICalEvent} and returns it. Use options to prefill the event's attributes.
2073
2073
  * Calling this method without options will create an empty event.
2074
2074
  *
2075
2075
  * ```javascript
@@ -2295,4 +2295,4 @@ declare function foldLines(input: string): string;
2295
2295
  */
2296
2296
  declare function ical(data?: ICalCalendarData): ICalCalendar;
2297
2297
 
2298
- 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 };
2298
+ 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 };