ical-generator 6.0.1 → 6.0.2-develop.10

package/package.json

@@ -8,35 +8,35 @@
   },
   "description": "ical-generator is a small piece of code which generates ical calendar files",
   "devDependencies": {
-    "@qiwi/semantic-release-gh-pages-plugin": "^5.2.11",
+    "@qiwi/semantic-release-gh-pages-plugin": "^5.2.12",
     "@semantic-release/changelog": "^6.0.3",
     "@semantic-release/exec": "^6.0.3",
     "@semantic-release/git": "^10.0.1",
     "@semantic-release/npm": "^11.0.2",
     "@touch4it/ical-timezones": "^1.9.0",
-    "@types/luxon": "^3.3.7",
+    "@types/luxon": "^3.4.2",
     "@types/mocha": "^10.0.6",
-    "@typescript-eslint/eslint-plugin": "^6.13.2",
-    "@typescript-eslint/parser": "^6.13.2",
-    "c8": "^8.0.1",
+    "@typescript-eslint/eslint-plugin": "^6.21.0",
+    "@typescript-eslint/parser": "^6.21.0",
+    "c8": "^9.1.0",
     "dayjs": "^1.11.10",
     "eslint": "^8.56.0",
-    "eslint-plugin-jsonc": "^2.11.2",
+    "eslint-plugin-jsonc": "^2.13.0",
     "esm": "^3.2.25",
     "license-checker": "^25.0.1",
     "luxon": "^3.4.4",
-    "mocha": "^10.2.0",
+    "mocha": "^10.3.0",
     "mochawesome": "^7.1.3",
-    "moment": "^2.29.4",
-    "moment-timezone": "^0.5.43",
+    "moment": "^2.30.1",
+    "moment-timezone": "^0.5.45",
     "nyc": "^15.1.0",
     "rrule": "^2.8.1",
-    "semantic-release": "^22.0.12",
+    "semantic-release": "^23.0.2",
     "semantic-release-license": "^1.0.2",
     "source-map-support": "^0.5.21",
     "ts-node": "^10.9.2",
-    "tsup": "^8.0.1",
-    "typedoc": "^0.25.4",
+    "tsup": "^8.0.2",
+    "typedoc": "^0.25.8",
     "typescript": "^5.3.3"
   },
   "engines": {
@@ -125,5 +125,5 @@
     "test": "mocha"
   },
   "type": "module",
-  "version": "6.0.1"
+  "version": "6.0.2-develop.10"
 }

package/src/alarm.ts

@@ -37,11 +37,11 @@ export type ICalAlarmData = ICalAlarmBaseData |
     ICalAlarmTriggerAfterData |
     ICalAlarmTriggerBeforeData;
 
-type ICalAlarmTriggerData = ICalAlarmBaseData & { trigger: number | ICalDateTimeValue };
-type ICalAlarmTriggerAfterData = ICalAlarmBaseData & { triggerAfter: number | ICalDateTimeValue };
-type ICalAlarmTriggerBeforeData = ICalAlarmBaseData & { triggerBefore: number | ICalDateTimeValue };
+export type ICalAlarmTriggerData = ICalAlarmBaseData & { trigger: number | ICalDateTimeValue };
+export type ICalAlarmTriggerAfterData = ICalAlarmBaseData & { triggerAfter: number | ICalDateTimeValue };
+export type ICalAlarmTriggerBeforeData = ICalAlarmBaseData & { triggerBefore: number | ICalDateTimeValue };
 
-interface ICalAlarmBaseData {
+export interface ICalAlarmBaseData {
     type?: ICalAlarmType;
     relatesTo?: ICalAlarmRelatesTo | null;
     repeat?: ICalAlarmRepeatData | null;
@@ -79,7 +79,7 @@ export 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';
@@ -88,7 +88,7 @@ export 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';
@@ -101,11 +101,11 @@ export default class ICalAlarm {
     private readonly event: ICalEvent;
 
     /**
-     * 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) {
         this.data = {
@@ -142,7 +142,7 @@ export default 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
      */
@@ -162,7 +162,7 @@ export default class ICalAlarm {
 
     /**
      * 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.
@@ -266,7 +266,7 @@ export default class ICalAlarm {
 
     /**
      * 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.
@@ -305,7 +305,7 @@ export default class ICalAlarm {
 
     /**
      * 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.

package/src/attendee.ts

@@ -75,7 +75,7 @@ export enum ICalAttendeeType {
 
 
 /**
- * Usually you get an `ICalAttendee` object like this:
+ * Usually you get an {@link ICalAttendee} object like this:
  *
  * ```javascript
  * import ical from 'ical-generator';
@@ -84,7 +84,7 @@ export 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';
@@ -97,11 +97,11 @@ export default class ICalAttendee {
     private readonly event: ICalEvent;
 
     /**
-     * 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) {
         this.data = {
@@ -232,7 +232,7 @@ export default class ICalAttendee {
 
     /**
      * 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
      */
@@ -279,7 +279,7 @@ export default 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
@@ -307,7 +307,7 @@ export default class ICalAttendee {
 
     /**
      * 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
      */
@@ -336,7 +336,7 @@ export default 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.
@@ -392,7 +392,7 @@ export default 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
@@ -426,7 +426,7 @@ export default 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();
@@ -449,7 +449,7 @@ export default 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();

package/src/calendar.ts

@@ -73,7 +73,7 @@ export enum ICalCalendarMethod {
 
 
 /**
- * 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();
@@ -89,7 +89,7 @@ export default class ICalCalendar {
     private readonly data: ICalCalendarInternalData;
 
     /**
-     * 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';
@@ -110,6 +110,16 @@ export default 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 = {}) {
@@ -150,7 +160,7 @@ export default 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
@@ -161,6 +171,11 @@ export default 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;
@@ -193,7 +208,7 @@ export default class ICalCalendar {
 
     /**
      * Get the feed method attribute.
-     * See [[`ICalCalendarMethod`]] for possible results.
+     * See {@link ICalCalendarMethod} for possible results.
      *
      * @since 0.2.8
      */
@@ -201,11 +216,13 @@ export default class ICalCalendar {
 
     /**
      * 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);
      * ```
      *
@@ -236,6 +253,24 @@ export default 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;
@@ -280,7 +315,7 @@ export default 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
@@ -312,7 +347,7 @@ export default 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
@@ -363,6 +398,10 @@ export default 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;
@@ -481,7 +520,7 @@ export default class ICalCalendar {
 
 
     /**
-     * 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
@@ -595,6 +634,14 @@ export default 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: {key: string, value: string}[] | [string, string][] | Record<string, string>): this;
@@ -608,6 +655,14 @@ export default 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;

package/src/category.ts

@@ -8,15 +8,16 @@ export interface ICalCategoryData {
     name: string;
 }
 
-export interface ICalCategoryInternalData {
+
+export interface ICalCategoryJSONData {
     name: string;
 }
 
-export type ICalCategoryJSONData = ICalCategoryInternalData;
+export 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';
@@ -25,7 +26,7 @@ export 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';
@@ -37,7 +38,7 @@ export default class ICalCategory {
     private readonly data: ICalCategoryInternalData;
 
     /**
-     * Constructor of [[`ICalCategory`]].
+     * Constructor of {@link ICalCategory}.
      * @param data Category Data
      */
     constructor(data: ICalCategoryData) {