@hebcal/icalendar 5.0.6 → 5.1.1

package/README.md

@@ -1,4 +1,4 @@
-# hebcal-icalendar
+# @hebcal/icalendar
 Jewish holidays and Hebrew calendar as iCalendar RFC 2445
 
 ## Installation

package/dist/icalendar.d.ts

@@ -0,0 +1,99 @@
+import { CalOptions, Event } from '@hebcal/core';
+export type ICalEventOptions = {
+    dtstamp?: string;
+    sequence?: number;
+    emoji?: boolean;
+    utmSource?: string;
+    utmMedium?: string;
+    utmCampaign?: string;
+    appendHebrewToSubject?: boolean;
+    prodid?: string;
+    caldesc?: string;
+    title?: string;
+    publishedTTL?: string | boolean;
+    calendarColor?: string;
+    relcalid?: string;
+    yahrzeit?: boolean;
+    subscribe?: string | boolean;
+    url?: boolean;
+};
+export type ICalOptions = CalOptions & ICalEventOptions;
+/**
+ * Represents an RFC 2445 iCalendar VEVENT
+ */
+export declare class IcalEvent {
+    ev: Event;
+    options: ICalOptions;
+    dtstamp: string;
+    sequence?: number;
+    timed: boolean;
+    locationName: string | null | undefined;
+    startDate: string;
+    isoDateOnly: string;
+    dtargs: string;
+    transp: string;
+    busyStatus: string;
+    endDate: string;
+    subj: string;
+    category: string | null;
+    lines?: string[];
+    /**
+     * Builds an IcalEvent object from a Hebcal Event
+     */
+    constructor(ev: Event, options?: ICalOptions);
+    getAlarm(): string | null;
+    /**
+     * @return {string}
+     */
+    getUid(): string;
+    /**
+     * @return {string[]}
+     */
+    getLongLines(): string[];
+    /**
+     * @return {string}
+     */
+    toString(): string;
+    /**
+     * fold lines to 75 characters
+     * @return {string[]}
+     */
+    getLines(): string[];
+    /**
+     * fold line to 75 characters
+     * @param {string} line
+     * @return {string}
+     */
+    static fold(line: string): string;
+    /**
+     * @param {string} str
+     * @return {string}
+     */
+    static escape(str: string): string;
+    /**
+     * @param {Date} dt
+     * @return {string}
+     */
+    static formatYYYYMMDD(dt: Date): string;
+    /**
+     * Returns UTC string for iCalendar
+     * @param {Date} dt
+     * @return {string}
+     */
+    static makeDtstamp(dt: Date): string;
+    /** @return {string} */
+    static version(): string;
+}
+/**
+ * Transforms a single Event into a VEVENT string
+ * @return {string} multi-line result, delimited by \r\n
+ */
+export declare function eventToIcal(ev: Event, options: ICalOptions): string;
+/**
+ * Generates an RFC 2445 iCalendar string from an array of events
+ */
+export declare function eventsToIcalendar(events: Event[], options: ICalOptions): Promise<string>;
+/**
+ * Generates an RFC 2445 iCalendar string from an array of IcalEvents
+ */
+export declare function icalEventsToString(icals: IcalEvent[], options: ICalOptions): Promise<string>;