@hebcal/core 5.4.7 → 5.4.9

package/dist/CalOptions.d.ts

@@ -1,5 +1,6 @@
 import { HDate } from '@hebcal/hdate';
 import { Location } from './location';
+export type DailyLearningValue = boolean | number | string;
 /**
  * Options to configure which events are returned
  */
@@ -152,6 +153,6 @@ export type CalOptions = {
      * the value should be a `number` for edition (`1` for Vilna, `2` for Schottenstein).
      */
     dailyLearning?: {
-        [x: string]: any;
+        [x: string]: DailyLearningValue;
     };
 };

package/dist/DailyLearning.d.ts

@@ -8,17 +8,14 @@ import { Event } from './event';
 export declare class DailyLearning {
     /**
      * Register a new learning calendar.
-     * @param {string} name
-     * @param {Function} calendar
      */
     static addCalendar(name: string, calendar: Function): void;
     /**
      * Returns an event from daily calendar for a given date. Returns `null` if there
      * is no learning from this calendar on this date.
-     * @param {string} name
-     * @param {HDate} hd
-     * @param {boolean} il
-     * @return {Event | null}
+     * @param name
+     * @param hd
+     * @param il
      */
     static lookup(name: string, hd: HDate, il: boolean): Event | null;
 }

package/dist/HebrewDateEvent.d.ts

@@ -4,11 +4,11 @@ import './locale';
 /** Daily Hebrew date ("11th of Sivan, 5780") */
 export declare class HebrewDateEvent extends Event {
     /**
-     * @param {HDate} date
+     * @param date
      */
     constructor(date: HDate);
     /**
-     * @param {string} [locale] Optional locale name (defaults to active locale).
+     * @param [locale] Optional locale name (defaults to active locale).
      * @example
      * import {HDate, HebrewDateEvent, months} from '@hebcal/core';
      *
@@ -16,17 +16,15 @@ export declare class HebrewDateEvent extends Event {
      * const ev = new HebrewDateEvent(hd);
      * console.log(ev.render('en')); // '15th of Cheshvan, 5769'
      * console.log(ev.render('he')); // 'ט״ו חֶשְׁוָן תשס״ט'
-     * @return {string}
      */
     render(locale?: string): string;
     /**
      * @private
-     * @param {string} locale
-     * @return {string}
+     * @param locale
      */
     private renderBriefHebrew;
     /**
-     * @param {string} [locale] Optional locale name (defaults to active locale).
+     * @param [locale] Optional locale name (defaults to active locale).
      * @example
      * import {HDate, HebrewDateEvent, months} from '@hebcal/core';
      *
@@ -34,7 +32,6 @@ export declare class HebrewDateEvent extends Event {
      * const ev = new HebrewDateEvent(hd);
      * console.log(ev.renderBrief()); // '15th of Cheshvan'
      * console.log(ev.renderBrief('he')); // 'ט״ו חֶשְׁוָן'
-     * @return {string}
      */
     renderBrief(locale?: string): string;
 }

package/dist/HolidayEvent.d.ts

@@ -17,33 +17,25 @@ export declare class HolidayEvent extends Event {
     startEvent?: TimedEvent;
     /** For a Fast day, this will be a "Fast ends" event */
     endEvent?: TimedEvent;
-    /** @return {string} */
     basename(): string;
-    /** @return {string | undefined} */
     url(): string | undefined;
-    /** @return {string} */
     urlDateSuffix(): string;
-    /** @return {string} */
     getEmoji(): string;
-    /** @return {string[]} */
     getCategories(): string[];
     /**
      * Returns (translated) description of this event
-     * @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;
     /**
      * Makes a clone of this Event object
-     * @return {Event}
      */
     clone(): HolidayEvent;
 }
@@ -52,7 +44,6 @@ export declare class HolidayEvent extends Event {
  * we subclass HolidayEvent to override the `url()` method.
  */
 export declare class AsaraBTevetEvent extends HolidayEvent {
-    /** @return {string} */
     urlDateSuffix(): string;
 }
 /** Represents Rosh Hashana, the Jewish New Year */
@@ -60,36 +51,31 @@ export declare class RoshHashanaEvent extends HolidayEvent {
     private readonly hyear;
     /**
      * @private
-     * @param {HDate} date Hebrew date event occurs
-     * @param {number} hyear Hebrew year
-     * @param {number} mask optional holiday flags
+     * @param date Hebrew date event occurs
+     * @param hyear Hebrew year
+     * @param mask optional holiday flags
      */
     constructor(date: HDate, hyear: number, mask: number);
     /**
      * Returns (translated) description of this event
-     * @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;
-    /** @return {string} */
     getEmoji(): string;
 }
 /** Represents Rosh Chodesh, the beginning of a new month */
 export declare class RoshChodeshEvent extends HolidayEvent {
     /**
      * Constructs Rosh Chodesh event
-     * @param {HDate} date Hebrew date event occurs
-     * @param {string} monthName Hebrew month name (not translated)
+     * @param date Hebrew date event occurs
+     * @param monthName Hebrew month name (not translated)
      */
     constructor(date: HDate, monthName: string);
     /**
      * Returns (translated) description of this event
-     * @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;
-    /** @return {string} */
     basename(): string;
-    /** @return {string} */
     getEmoji(): string;
 }

package/dist/MevarchimChodeshEvent.d.ts

@@ -6,23 +6,20 @@ export declare class MevarchimChodeshEvent extends Event {
     readonly monthName: string;
     /**
      * Constructs Mevarchim haChodesh event
-     * @param {HDate} date Hebrew date event occurs
-     * @param {string} monthName Hebrew month name (not translated)
-     * @param {string} [memo]
+     * @param date Hebrew date event occurs
+     * @param monthName Hebrew month name (not translated)
+     * @param [memo]
      */
     constructor(date: HDate, monthName: string, memo: string);
-    /** @return {string} */
     basename(): string;
     /**
      * Returns (translated) description of this event
-     * @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 (translated) description of this event
-     * @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;
 }

package/dist/ParshaEvent.d.ts

@@ -9,22 +9,15 @@ export declare class ParshaEvent extends Event {
     readonly il: boolean;
     readonly num: number | number[];
     /**
-     * @param {HDate} date
-     * @param {string[]} parsha - untranslated name of single or double parsha,
+     * @param parsha - untranslated name of single or double parsha,
      *   such as ['Bereshit'] or ['Achrei Mot', 'Kedoshim']
-     * @param {boolean} [il]
-     * @param {number|number[]} [num]
      */
     constructor(date: HDate, parsha: string[], il?: boolean, num?: number | number[]);
     /**
-     * @param {string} [locale] Optional locale name (i.e: `'he'`, `'fr'`). Defaults to active locale.
-     * @return {string}
+     * @param [locale] Optional locale name (i.e: `'he'`, `'fr'`). Defaults to active locale.
      */
     render(locale?: string): string;
-    /** @return {string} */
     basename(): string;
-    /** @return {string | undefined} */
     url(): string | undefined;
-    /** @return {string} */
     urlDateSuffix(): string;
 }

package/dist/TimedEvent.d.ts

@@ -11,27 +11,23 @@ export declare class TimedEvent extends Event {
     readonly fmtTime: string;
     readonly linkedEvent?: Event;
     /**
-     * @param {string} desc Description (not translated)
+     * @param desc Description (not translated)
      */
     constructor(date: HDate, desc: string, mask: number, eventTime: Date, location: Location, linkedEvent?: Event, options?: CalOptions);
     /**
-     * @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 translation of "Candle lighting" without the time.
-     * @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;
-    /** @return {string[]} */
     getCategories(): string[];
 }
 /** Candle lighting before Shabbat or holiday */
 export declare class CandleLightingEvent extends TimedEvent {
     constructor(date: HDate, mask: number, eventTime: Date, location: Location, linkedEvent?: Event, options?: CalOptions);
-    /** @return {string} */
     getEmoji(): string;
 }
 /** Havdalah after Shabbat or holiday */
@@ -39,16 +35,13 @@ export declare class HavdalahEvent extends TimedEvent {
     private readonly havdalahMins?;
     constructor(date: HDate, mask: number, eventTime: Date, location: Location, havdalahMins?: number, linkedEvent?: Event, options?: CalOptions);
     /**
-     * @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 translation of "Havdalah" without the time.
-     * @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;
-    /** @return {string} */
     getEmoji(): string;
 }

package/dist/YomKippurKatanEvent.d.ts

@@ -7,22 +7,18 @@ export declare class YomKippurKatanEvent extends HolidayEvent {
     private readonly nextMonthName;
     /**
      * @private
-     * @param {HDate} date Hebrew date event occurs
-     * @param {string} nextMonthName name of the upcoming month
+     * @param date Hebrew date event occurs
+     * @param nextMonthName name of the upcoming month
      */
     constructor(date: HDate, nextMonthName: string);
-    /** @return {string} */
     basename(): string;
     /**
-     * @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;
     /**
-     * @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;
-    /** @return {string | undefined} */
     url(): string | undefined;
 }