@hebcal/core 5.4.8 → 5.4.9

package/dist/event.d.ts

@@ -1,7 +1,8 @@
 import { HDate } from '@hebcal/hdate';
 import './locale';
 /**
- * Holiday flags for Event
+ * Holiday flags for Event. These flags are typically
+ * combined using bitwise arithmetic to form a mask.
  * @readonly
  * @enum {number}
  */
@@ -61,35 +62,54 @@ export declare const flags: {
     /** Daily Learning */
     DAILY_LEARNING: number;
 };
-/** Represents an Event with a title, date, and flags */
+/**
+ * Represents an Event with a title, date, and flags.
+ *
+ * Events are used to represent holidays, candle-lighting times,
+ * Torah readings, and more.
+ *
+ * To get the title of the event a language other than English
+ * with Sephardic transliterations, use the `render()` method.
+ */
 export declare class Event {
+    /** Hebrew date of this event */
     readonly date: HDate;
+    /**
+     * Untranslated title of this event. Note that these description
+     * strings are always in English and will remain stable across releases.
+     * To get the title of the event in another language, use the
+     * `render()` method.
+     */
     readonly desc: string;
+    /** Bitmask of optional event flags. See {@link flags} */
     readonly mask: number;
+    /** Optional emoji character such as ✡️, 🕯️, 🕎, 🕍, 🌒 */
     emoji?: string;
+    /** Optional longer description or memo text */
     memo?: string;
+    /** Alarms are used by iCalendar feeds */
     alarm?: Date | string | boolean;
     /**
      * Constructs Event
-     * @param {HDate} date Hebrew date event occurs
-     * @param {string} desc Description (not translated)
-     * @param {number} [mask=0] optional bitmask of holiday flags (see {@link flags})
-     * @param {Object} [attrs={}] optional additional attributes (e.g. `eventTimeStr`, `cholHaMoedDay`)
+     * @param date Hebrew date event occurs
+     * @param desc Description (not translated)
+     * @param [mask=0] optional bitmask of holiday flags (see {@link flags})
+     * @param [attrs={}] optional additional attributes (e.g. `eventTimeStr`, `cholHaMoedDay`)
      */
     constructor(date: HDate, desc: string, mask?: number, attrs?: object);
     /**
      * Hebrew date of this event
-     * @return {HDate}
      */
     getDate(): HDate;
     /**
-     * Untranslated description of this event
-     * @return {string}
+     * Untranslated title of this event. Note that these description
+     * strings are always in English and will remain stable across releases.
+     * To get the title of the event in another language, use the
+     * `render()` method.
      */
     getDesc(): string;
     /**
      * Bitmask of optional event flags. See {@link flags}
-     * @return {number}
      */
     getFlags(): number;
     /**
@@ -99,35 +119,30 @@ export declare class Event {
      * ev.render('en'); // 'Shavuot'
      * ev.render('he'); // 'שָׁבוּעוֹת'
      * ev.render('ashkenazi'); // 'Shavuos'
-     * @param {string} [locale] Optional locale name (defaults to active locale).
-     * @return {string}
+     * @param [locale] Optional locale name (defaults to active locale).
      */
     render(locale?: string): string;
     /**
      * Returns a brief (translated) description of this event.
      * For most events, this is the same as render(). For some events, it procudes
      * a shorter text (e.g. without a time or added description).
-     * @param {string} [locale] Optional locale name (defaults to active locale).
-     * @return {string}
+     * @param [locale] Optional locale name (defaults to active locale).
      */
     renderBrief(locale?: string): string;
     /**
      * Optional holiday-specific Emoji or `null`.
-     * @return {string | null}
      */
     getEmoji(): string | null;
     /**
      * Returns a simplified (untranslated) description for this event. For example,
-     * the {@link HolidayEvent} class supports
+     * the `HolidayEvent` class supports
      * "Erev Pesach" => "Pesach", and "Sukkot III (CH''M)" => "Sukkot".
      * For many holidays the basename and the event description are the same.
-     * @return {string}
      */
     basename(): string;
     /**
      * Returns a URL to hebcal.com or sefaria.org for more detail on the event.
      * Returns `undefined` for events with no detail page.
-     * @return {string | undefined}
      */
     url(): string | undefined;
     /**
@@ -137,7 +152,6 @@ export declare class Event {
      * ev1.observedInIsrael(); // false
      * const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
      * ev2.observedInIsrael(); // true
-     * @return {boolean}
      */
     observedInIsrael(): boolean;
     /**
@@ -147,7 +161,6 @@ export declare class Event {
      * ev1.observedInDiaspora(); // true
      * const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
      * ev2.observedInDiaspora(); // true
-     * @return {boolean}
      */
     observedInDiaspora(): boolean;
     /**
@@ -159,18 +172,15 @@ export declare class Event {
      * const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
      * ev2.observedIn(false); // true
      * ev2.observedIn(true); // true
-     * @param {boolean} il
-     * @return {boolean}
+     * @param il
      */
     observedIn(il: boolean): boolean;
     /**
      * Makes a clone of this Event object
-     * @return {Event}
      */
     clone(): Event;
     /**
      * Returns a list of event categories
-     * @return {string[]}
      */
     getCategories(): string[];
 }

package/dist/hallel.d.ts

@@ -2,8 +2,5 @@ import { HDate } from '@hebcal/hdate';
 import { Event } from './event';
 /**
  * @private
- * @param {Event[]} events
- * @param {HDate} hdate
- * @return {number}
  */
 export declare function hallel_(events: Event[], hdate: HDate): number;

package/dist/hebcal.d.ts

@@ -119,8 +119,6 @@ export declare class HebrewCalendar {
      *   const date = hd.greg();
      *   console.log(date.toLocaleDateString(), ev.render('en'), hd.toString());
      * }
-     * @param {CalOptions} [options={}]
-     * @return {Event[]}
      */
     static calendar(options?: CalOptions): Event[];
     /**
@@ -145,9 +143,9 @@ export declare class HebrewCalendar {
      * const dt = new Date(2014, 2, 2); // '2014-03-02' == '30 Adar I 5774'
      * const hd = HebrewCalendar.getBirthdayOrAnniversary(5780, dt); // '1 Nisan 5780'
      * console.log(hd.greg().toLocaleDateString('en-US')); // '3/26/2020'
-     * @param {number} hyear Hebrew year
-     * @param {Date|HDate} gdate Gregorian or Hebrew date of event
-     * @return {HDate | undefined} anniversary occurring in `hyear`
+     * @param hyear Hebrew year
+     * @param gdate Gregorian or Hebrew date of event
+     * @returns anniversary occurring in `hyear`
      */
     static getBirthdayOrAnniversary(hyear: number, gdate: Date | HDate): HDate | undefined;
     /**
@@ -180,39 +178,32 @@ export declare class HebrewCalendar {
      * const dt = new Date(2014, 2, 2); // '2014-03-02' == '30 Adar I 5774'
      * const hd = HebrewCalendar.getYahrzeit(5780, dt); // '30 Sh\'vat 5780'
      * console.log(hd.greg().toLocaleDateString('en-US')); // '2/25/2020'
-     * @param {number} hyear Hebrew year
-     * @param {Date|HDate} gdate Gregorian or Hebrew date of death
-     * @return {HDate | undefined} anniversary occurring in hyear
+     * @param hyear Hebrew year
+     * @param gdate Gregorian or Hebrew date of death
+     * @returns anniversary occurring in hyear
      */
     static getYahrzeit(hyear: number, gdate: Date | HDate): HDate | undefined;
     /**
      * Lower-level holidays interface, which returns a `Map` of `Event`s indexed by
      * `HDate.toString()`. These events must filtered especially for `flags.IL_ONLY`
      * or `flags.CHUL_ONLY` depending on Israel vs. Diaspora holiday scheme.
-     * @function
-     * @param {number} year Hebrew year
-     * @return {HolidayYearMap}
+     * @param year Hebrew year
      */
     static getHolidaysForYear(year: number): HolidayYearMap;
     /**
      * Returns an array of holidays for the year
-     * @param {number} year Hebrew year
-     * @param {boolean} il use the Israeli schedule for holidays
-     * @return {HolidayEvent[]}
+     * @param year Hebrew year
+     * @param il use the Israeli schedule for holidays
      */
     static getHolidaysForYearArray(year: number, il: boolean): HolidayEvent[];
     /**
      * Returns an array of Events on this date (or `undefined` if no events)
-     * @param {HDate|Date|number} date Hebrew Date, Gregorian date, or absolute R.D. day number
-     * @param {boolean} [il] use the Israeli schedule for holidays
-     * @return {HolidayEvent[] | undefined}
+     * @param date Hebrew Date, Gregorian date, or absolute R.D. day number
+     * @param [il] use the Israeli schedule for holidays
      */
     static getHolidaysOnDate(date: HDate | Date | number, il?: boolean): HolidayEvent[] | undefined;
     /**
      * Eruv Tavshilin
-     * @param {Date | HDate} date
-     * @param {boolean} il
-     * @return {boolean}
      */
     static eruvTavshilin(date: Date | HDate, il: boolean): boolean;
     /**
@@ -221,21 +212,15 @@ export declare class HebrewCalendar {
      * locale.
      * If `options.hour12` is `false`, locale is ignored and always returns 24-hour time.
      * If `options.hour12` is `true`, locale is ignored and always returns 12-hour time.
-     * @param {string} timeStr - original time like "20:30"
-     * @param {string} suffix - "p" or "pm" or " P.M.". Add leading space if you want it
-     * @param {CalOptions} options
-     * @return {string}
+     * @param timeStr - original time like "20:30"
+     * @param suffix - "p" or "pm" or " P.M.". Add leading space if you want it
+     * @param options
      */
     static reformatTimeStr(timeStr: string, suffix: string, options: CalOptions): string;
-    /** @return {string} */
     static version(): string;
     /**
      * Convenience function to create an instance of `Sedra` or reuse a previously
      * created and cached instance.
-     * @function
-     * @param {number} hyear
-     * @param {boolean} il
-     * @return {Sedra}
      */
     static getSedra(hyear: number, il: boolean): Sedra;
     /**
@@ -251,10 +236,6 @@ export declare class HebrewCalendar {
      * 0 - No Hallel
      * 1 - Half Hallel
      * 2 - Whole Hallel
-     *
-     * @param {HDate} hdate
-     * @param {boolean} il
-     * @return {number}
      */
     static hallel(hdate: HDate, il: boolean): number;
     /**
@@ -272,9 +253,6 @@ export declare class HebrewCalendar {
      * Tachanun is not said at Mincha on days before it is not said at Shacharit.
      *
      * Tachanun is not said at Shacharit on Shabbat, but is at Mincha, usually.
-     * @param {HDate} hdate
-     * @param {boolean} il
-     * @return {TachanunResult}
      */
     static tachanun(hdate: HDate, il: boolean): TachanunResult;
 }