ical-generator 8.1.2-develop.9 → 9.0.0-develop.2

package/src/types.ts

@@ -1,35 +1,49 @@
+export enum ICalEventRepeatingFreq {
+    DAILY = 'DAILY',
+    HOURLY = 'HOURLY',
+    MINUTELY = 'MINUTELY',
+    MONTHLY = 'MONTHLY',
+    SECONDLY = 'SECONDLY',
+    WEEKLY = 'WEEKLY',
+    YEARLY = 'YEARLY',
+}
+
+export enum ICalWeekday {
+    FR = 'FR',
+    MO = 'MO',
+    SA = 'SA',
+    SU = 'SU',
+    TH = 'TH',
+    TU = 'TU',
+    WE = 'WE',
+}
+
 /**
  * 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.
  */
-export type ICalDateTimeValue = Date | ICalMomentStub | ICalMomentTimezoneStub | ICalLuxonDateTimeStub | ICalDayJsStub | string;
+export type ICalDateTimeValue =
+    | Date
+    | ICalDayJsStub
+    | ICalLuxonDateTimeStub
+    | ICalMomentStub
+    | ICalMomentTimezoneStub
+    | string;
 
-export 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;
-}
-
-export type ICalLocation = ICalLocationWithTitle | ICalLocationWithoutTitle;
-
-export interface ICalLocationWithTitle {
-    title: string;
-    address?: string;
-    radius?: number;
-    geo?: ICalGeo;
+export interface ICalDayJsStub {
+    format(format?: string): string;
+    isValid(): boolean;
+    toDate(): Date;
+    toJSON(): string;
+    tz(zone?: string): ICalDayJsStub;
+    utc(): ICalDayJsStub;
 }
 
-export interface ICalLocationWithoutTitle {
-    geo: ICalGeo;
+export interface ICalDescription {
+    html?: string;
+    plain: string;
 }
 
 export interface ICalGeo {
@@ -37,82 +51,79 @@ export interface ICalGeo {
     lon: number;
 }
 
-export interface ICalOrganizer {
-    name: string;
-    email?: string;
-    mailto?: string;
-    sentBy?: string;
+export type ICalLocation = ICalLocationWithoutTitle | ICalLocationWithTitle;
+
+export interface ICalLocationWithoutTitle {
+    geo: ICalGeo;
 }
 
-export interface ICalDescription {
-    plain: string;
-    html?: string;
+export interface ICalLocationWithTitle {
+    address?: string;
+    geo?: ICalGeo;
+    radius?: number;
+    title: string;
 }
 
-export interface ICalTimezone {
-    name: string | null;
-    generator?: (timezone: string) => string|null;
+export interface ICalLuxonDateTimeStub {
+    get isValid(): boolean;
+    setZone(zone?: string): ICalLuxonDateTimeStub;
+    toFormat(fmt: string): string;
+    toJSDate(): Date;
+    toJSON(): null | string;
+    zone: { type: string };
+}
+
+export interface ICalMomentDurationStub {
+    asSeconds(): number;
 }
 
 export interface ICalMomentStub {
-    format(format?: string): string;
     clone(): ICalMomentStub;
-    utc(): ICalMomentStub;
-    toDate(): Date;
+    format(format?: string): string;
     isValid(): boolean;
+    toDate(): Date;
     toJSON(): string;
+    utc(): ICalMomentStub;
 }
 
 export interface ICalMomentTimezoneStub extends ICalMomentStub {
     clone(): ICalMomentTimezoneStub;
-    utc(): ICalMomentTimezoneStub;
     tz(): string | undefined;
     tz(timezone: string): ICalMomentTimezoneStub;
+    utc(): ICalMomentTimezoneStub;
 }
 
-export interface ICalMomentDurationStub {
-    asSeconds(): number;
-}
-
-export interface ICalLuxonDateTimeStub {
-    setZone(zone?: string): ICalLuxonDateTimeStub;
-    zone: { type: string; };
-    toFormat(fmt: string): string;
-    toJSDate(): Date;
-    get isValid(): boolean;
-    toJSON(): string | null;
+export interface ICalOrganizer {
+    email?: string;
+    mailto?: string;
+    name: string;
+    sentBy?: string;
 }
 
-export interface ICalDayJsStub {
-    tz(zone?: string): ICalDayJsStub;
-    utc(): ICalDayJsStub;
-    format(format?: string): string;
-    toDate(): Date;
-    isValid(): boolean;
-    toJSON(): string;
+export interface ICalRepeatingOptions {
+    byDay?: ICalWeekday | ICalWeekday[];
+    byMonth?: number | number[];
+    byMonthDay?: number | number[];
+    bySetPos?: number | number[];
+    count?: number;
+    exclude?: ICalDateTimeValue | ICalDateTimeValue[];
+    freq: ICalEventRepeatingFreq;
+    interval?: number;
+    startOfWeek?: ICalWeekday;
+    until?: ICalDateTimeValue;
 }
 
 export interface ICalRRuleStub {
-    between(after: Date, before: Date, inc?: boolean, iterator?: (d: Date, len: number) => boolean): Date[];
+    between(
+        after: Date,
+        before: Date,
+        inc?: boolean,
+        iterator?: (d: Date, len: number) => boolean,
+    ): Date[];
     toString(): string;
 }
 
-export enum ICalEventRepeatingFreq {
-    SECONDLY = 'SECONDLY',
-    MINUTELY = 'MINUTELY',
-    HOURLY = 'HOURLY',
-    DAILY = 'DAILY',
-    WEEKLY = 'WEEKLY',
-    MONTHLY = 'MONTHLY',
-    YEARLY = 'YEARLY'
-}
-
-export enum ICalWeekday {
-    SU = 'SU',
-    MO = 'MO',
-    TU = 'TU',
-    WE = 'WE',
-    TH = 'TH',
-    FR = 'FR',
-    SA = 'SA'
+export interface ICalTimezone {
+    generator?: (timezone: string) => null | string;
+    name: null | string;
 }