ical-generator 5.0.2-develop.2 → 6.0.0-develop.1

package/dist/index.d.cts

@@ -1,8 +1,6 @@
-import { ServerResponse } from 'node:http';
-
 interface ICalAttendeeData {
     name?: string | null;
-    email?: string | null;
+    email: string;
     mailto?: string | null;
     sentBy?: string | null;
     status?: ICalAttendeeStatus | null;
@@ -20,7 +18,7 @@ interface ICalAttendeeData {
 }
 interface ICalAttendeeJSONData {
     name: string | null;
-    email: string | null;
+    email: string;
     mailto: string | null;
     sentBy: string | null;
     status: ICalAttendeeStatus | null;
@@ -61,14 +59,14 @@ declare enum ICalAttendeeType {
  * import ical from 'ical-generator';
  * const calendar = ical();
  * const event = calendar.createEvent();
- * const attendee = event.createAttendee();
+ * const attendee = event.createAttendee({ email: 'mail@example.com' });
  * ```
  *
  * You can also use the [[`ICalAttendee`]] object directly:
  *
  * ```javascript
  * import ical, {ICalAttendee} from 'ical-generator';
- * const attendee = new ICalAttendee();
+ * const attendee = new ICalAttendee({ email: 'mail@example.com' });
  * event.attendees([attendee]);
  * ```
  */
@@ -97,12 +95,12 @@ declare class ICalAttendee {
      * Get the attendee's email address
      * @since 0.2.0
      */
-    email(): string | null;
+    email(): string;
     /**
      * Set the attendee's email address
      * @since 0.2.0
      */
-    email(email: string | null): this;
+    email(email: string): this;
     /**
      * Get the attendee's email address
      * @since 1.3.0
@@ -418,14 +416,20 @@ interface ICalAttachment {
     uri: string;
     mime: string | null;
 }
-interface ICalAlarmData {
-    type?: ICalAlarmType | null;
-    trigger?: number | ICalDateTimeValue | 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;
-    triggerBefore?: number | ICalDateTimeValue | null;
-    triggerAfter?: number | ICalDateTimeValue | null;
-    repeat?: number | null;
-    interval?: number | null;
+    repeat?: ICalAlarmRepeatData | null;
     attach?: string | ICalAttachment | null;
     description?: string | null;
     x?: {
@@ -433,11 +437,15 @@ interface ICalAlarmData {
         value: string;
     }[] | [string, string][] | Record<string, string>;
 }
+interface ICalAlarmRepeatData {
+    times: number;
+    interval: number;
+}
 interface ICalAlarmJSONData {
-    type: ICalAlarmType | null;
-    trigger: string | number | null;
+    type: ICalAlarmType;
+    trigger: string | number;
     relatesTo: ICalAlarmRelatesTo | null;
-    repeat: number | null;
+    repeat: ICalAlarmRepeatData | null;
     interval: number | null;
     attach: ICalAttachment | null;
     description: string | null;
@@ -479,13 +487,13 @@ declare class ICalAlarm {
      * Get the alarm type
      * @since 0.2.1
      */
-    type(type: ICalAlarmType | null): this;
+    type(type: ICalAlarmType): this;
     /**
      * Set the alarm type. See [[`ICalAlarmType`]]
      * for available status options.
      * @since 0.2.1
      */
-    type(): ICalAlarmType | null;
+    type(): ICalAlarmType;
     /**
      * Get the trigger time for the alarm. Can either
      * be a date and time value ([[`ICalDateTimeValue`]]) or
@@ -495,7 +503,7 @@ declare class ICalAlarm {
      *
      * @since 0.2.1
      */
-    trigger(): number | ICalDateTimeValue | null;
+    trigger(): number | ICalDateTimeValue;
     /**
      * Use this method to set the alarm time.
      *
@@ -514,7 +522,7 @@ declare class ICalAlarm {
      *
      * @since 0.2.1
      */
-    trigger(trigger: number | ICalDateTimeValue | Date | null): this;
+    trigger(trigger: number | ICalDateTimeValue | Date): this;
     /**
      * Get to which time alarm trigger relates to.
      * Can be either `START` or `END`. If the value is
@@ -555,7 +563,7 @@ declare class ICalAlarm {
      *
      * @since 0.2.1
      */
-    triggerAfter(): number | ICalDateTimeValue | null;
+    triggerAfter(): number | ICalDateTimeValue;
     /**
      * Use this method to set the alarm time. Unlike `trigger`, this time
      * the alarm takes place after the event has started.
@@ -574,7 +582,7 @@ declare class ICalAlarm {
      *
      * @since 0.2.1
      */
-    triggerAfter(trigger: number | ICalDateTimeValue | null): this;
+    triggerAfter(trigger: number | ICalDateTimeValue): this;
     /**
      * Get the trigger time for the alarm. Can either
      * be a date and time value ([[`ICalDateTimeValue`]]) or
@@ -585,7 +593,7 @@ declare class ICalAlarm {
      * @since 0.2.1
      * @alias trigger
      */
-    triggerBefore(trigger: number | ICalDateTimeValue | null): this;
+    triggerBefore(trigger: number | ICalDateTimeValue): this;
     /**
      * Use this method to set the alarm time.
      *
@@ -605,12 +613,12 @@ declare class ICalAlarm {
      * @since 0.2.1
      * @alias trigger
      */
-    triggerBefore(): number | ICalDateTimeValue | null;
+    triggerBefore(): number | ICalDateTimeValue;
     /**
      * Get Alarm Repetitions
      * @since 0.2.1
      */
-    repeat(): number | null;
+    repeat(): ICalAlarmRepeatData | null;
     /**
      * Set Alarm Repetitions. Use this to repeat the alarm.
      *
@@ -620,36 +628,16 @@ declare class ICalAlarm {
      *
      * // repeat the alarm 4 times every 5 minutes…
      * cal.createAlarm({
-     *     repeat: 4,
-     *     interval: 300
-     * });
-     * ```
-     *
-     * @since 0.2.1
-     */
-    repeat(repeat: number | null): this;
-    /**
-     * Get Repeat Interval
-     * @since 0.2.1
-     */
-    interval(interval: number | null): this;
-    /**
-     * Set Repeat Interval
-     *
-     * ```javascript
-     * const cal = ical();
-     * const event = cal.createEvent();
-     *
-     * // repeat the alarm 4 times every 5 minutes…
-     * cal.createAlarm({
-     *     repeat: 4,
-     *     interval: 300
+     *     repeat: {
+     *         times: 4,
+     *         interval: 300
+     *     }
      * });
      * ```
      *
      * @since 0.2.1
      */
-    interval(): number | null;
+    repeat(repeat: ICalAlarmRepeatData | null): this;
     /**
      * Get Attachment
      * @since 0.2.1
@@ -768,11 +756,12 @@ declare class ICalAlarm {
 }
 
 interface ICalCategoryData {
-    name?: string | null;
+    name: string;
 }
 interface ICalCategoryInternalData {
-    name: string | null;
+    name: string;
 }
+type ICalCategoryJSONData = ICalCategoryInternalData;
 /**
  * Usually you get an `ICalCategory` object like this:
  *
@@ -802,12 +791,12 @@ declare class ICalCategory {
      * Get the category name
      * @since 0.3.0
      */
-    name(): string | null;
+    name(): string;
     /**
      * Set the category name
      * @since 0.3.0
      */
-    name(name: string | null): this;
+    name(name: string): this;
     /**
      * Return a shallow copy of the category's options for JSON stringification.
      * Can be used for persistence.
@@ -848,7 +837,7 @@ declare enum ICalEventClass {
 interface ICalEventData {
     id?: string | number | null;
     sequence?: number;
-    start?: ICalDateTimeValue | null;
+    start: ICalDateTimeValue;
     end?: ICalDateTimeValue | null;
     recurrenceId?: ICalDateTimeValue | null;
     timezone?: string | null;
@@ -880,7 +869,7 @@ interface ICalEventData {
 interface ICalEventJSONData {
     id: string;
     sequence: number;
-    start: string | null;
+    start: string;
     end: string | null;
     recurrenceId: string | null;
     timezone: string | null;
@@ -986,7 +975,7 @@ declare class ICalEvent {
      *
      * @since 0.2.0
      */
-    start(): ICalDateTimeValue | null;
+    start(): ICalDateTimeValue;
     /**
      * Set the appointment date of beginning, which is required for all events.
      * You can use any supported date object, see
@@ -1260,7 +1249,7 @@ declare class ICalEvent {
      *
      * @since 0.2.0
      */
-    createAttendee(data?: ICalAttendee | ICalAttendeeData | string): ICalAttendee;
+    createAttendee(data: ICalAttendee | ICalAttendeeData | string): ICalAttendee;
     /**
      * Get all attendees
      * @since 0.2.0
@@ -1302,7 +1291,7 @@ declare class ICalEvent {
      *
      * @since 0.2.1
      */
-    createAlarm(data?: ICalAlarm | ICalAlarmData): ICalAlarm;
+    createAlarm(data: ICalAlarm | ICalAlarmData): ICalAlarm;
     /**
      * Get all alarms
      * @since 0.2.0
@@ -1342,7 +1331,7 @@ declare class ICalEvent {
      *
      * @since 0.3.0
      */
-    createCategory(data?: ICalCategory | ICalCategoryData): ICalCategory;
+    createCategory(data: ICalCategory | ICalCategoryData): ICalCategory;
     /**
      * Get all categories
      * @since 0.3.0
@@ -1945,58 +1934,6 @@ declare class ICalCalendar {
      * @since 2.0.0-develop.1
      */
     clear(): this;
-    /**
-     * Save ical file using [`fs/promises`](https://nodejs.org/api/fs.html#fs_fspromises_writefile_file_data_options).
-     * Only works in node.js environments.
-     *
-     * ```javascript
-     * await calendar.save('./calendar.ical');
-     * ```
-     */
-    save(path: string): Promise<void>;
-    /**
-     * Save ical file with [`fs.writeFile`](http://nodejs.org/api/fs.html#fs_fs_writefile_filename_data_options_callback).
-     * Only works in node.js environments.
-     *
-     * ```javascript
-     * calendar.save('./calendar.ical', err => {
-     *     console.log(err);
-     * });
-     * ```
-     */
-    save(path: string, cb?: (err: NodeJS.ErrnoException | null) => void): this;
-    /**
-     * Save Calendar to disk synchronously using
-     * [fs.writeFileSync](http://nodejs.org/api/fs.html#fs_fs_writefilesync_filename_data_options).
-     * Only works in node.js environments.
-     *
-     * ```javascript
-     * calendar.saveSync('./calendar.ical');
-     * ```
-     */
-    saveSync(path: string): this;
-    /**
-     * Send calendar to the user when using HTTP using the passed `ServerResponse` object.
-     * Use second parameter `filename` to change the filename, which defaults to `'calendar.ics'`.
-     *
-     * @param response HTTP Response object which is used to send the calendar
-     * @param [filename = 'calendar.ics'] Filename of the calendar file
-     */
-    serve(response: ServerResponse, filename?: string): this;
-    /**
-     * Generates a blob to use for downloads or to generate a download URL.
-     * Only supported in browsers supporting the Blob API.
-     *
-     * @since 1.9.0
-     */
-    toBlob(): Blob;
-    /**
-     * Returns a URL to download the ical file. Uses the Blob object internally,
-     * so it's only supported in browsers supporting the Blob API.
-     *
-     * @since 1.9.0
-     */
-    toURL(): string;
     /**
      * Set X-* attributes. Woun't filter double attributes,
      * which are also added by another method (e.g. busystatus),
@@ -2137,4 +2074,4 @@ declare function foldLines(input: string): string;
  */
 declare function ical(data?: ICalCalendarData): ICalCalendar;
 
-export { ICalAlarm, ICalAlarmData, ICalAlarmJSONData, ICalAlarmType, ICalAlarmTypeValue, ICalAttachment, ICalAttendee, ICalAttendeeData, ICalAttendeeJSONData, ICalAttendeeRole, ICalAttendeeStatus, ICalAttendeeType, ICalCalendar, ICalCalendarData, ICalCalendarJSONData, ICalCalendarMethod, ICalCalendarProdIdData, ICalCategory, ICalCategoryData, ICalDateTimeValue, ICalDayJsStub, ICalDescription, ICalEvent, ICalEventBusyStatus, ICalEventClass, ICalEventData, ICalEventJSONData, ICalEventRepeatingFreq, ICalEventStatus, ICalEventTransparency, ICalGeo, ICalLocation, ICalLuxonDateTimeStub, ICalMomentDurationStub, ICalMomentStub, ICalMomentTimezoneStub, ICalOrganizer, ICalRRuleStub, ICalRepeatingOptions, ICalTimezone, ICalWeekday, ical as default, escape, foldLines, formatDate, formatDateTZ };
+export { ICalAlarm, ICalAlarmData, ICalAlarmJSONData, ICalAlarmRepeatData, ICalAlarmType, ICalAlarmTypeValue, ICalAttachment, ICalAttendee, ICalAttendeeData, ICalAttendeeJSONData, ICalAttendeeRole, ICalAttendeeStatus, ICalAttendeeType, ICalCalendar, ICalCalendarData, ICalCalendarJSONData, ICalCalendarMethod, ICalCalendarProdIdData, ICalCategory, ICalCategoryData, ICalCategoryJSONData, ICalDateTimeValue, ICalDayJsStub, ICalDescription, ICalEvent, ICalEventBusyStatus, ICalEventClass, ICalEventData, ICalEventJSONData, ICalEventRepeatingFreq, ICalEventStatus, ICalEventTransparency, ICalGeo, ICalLocation, ICalLuxonDateTimeStub, ICalMomentDurationStub, ICalMomentStub, ICalMomentTimezoneStub, ICalOrganizer, ICalRRuleStub, ICalRepeatingOptions, ICalTimezone, ICalWeekday, ical as default, escape, foldLines, formatDate, formatDateTZ };