@hebcal/core 5.10.1 → 6.0.1

package/README.md

@@ -32,12 +32,12 @@ This package exports 3 categories of output:
 
 - `dist/bundle.min.js`: This includes all dependencies in a single JS file.  It's quite large (174KB minified), and should only be used if you aren't using a bundler.
 - `dist/index.cjs`: This includes all of this package's code in a single bundle.
-- `dist/es/`: This directory contains ES modules for each source file in the package.  If you're using Rollup, Vite, or another bundler, you should import from here to reduce output sizes.
+- `dist/esm/`: This directory contains ES modules for each source file in the package.  If you're using Rollup, Vite, or another bundler, you should import from here to reduce output sizes.
   - These files do not include polyfills; if you want to support older browsers, use <https://github.com/rollup/plugins/tree/master/packages/babel#babelhelpers>
   - To make tree-shaking work better, import from the most specific file possible; avoid importing from `index` or `hebcal`.  Some APIs may still need to be moved to specific files.  For example:
 
     ```ts
-    import {getHolidaysOnDate} from '@hebcal/core/dist/es/holidays';
+    import {getHolidaysOnDate} from '@hebcal/core/dist/esm/holidays';
     ```
 
   - This can save hundreds of kilobytes by dropping Zmanim dependencies if your code doesn't use them.

package/dist/HebrewDateEvent.d.ts

@@ -8,7 +8,7 @@ export declare class HebrewDateEvent extends Event {
      */
     constructor(date: HDate);
     /**
-     * @param [locale] Optional locale name (defaults to active locale).
+     * @param [locale] Optional locale name (defaults to empty locale)
      * @example
      * import {HDate, HebrewDateEvent, months} from '@hebcal/core';
      *
@@ -24,7 +24,7 @@ export declare class HebrewDateEvent extends Event {
      */
     private renderBriefHebrew;
     /**
-     * @param [locale] Optional locale name (defaults to active locale).
+     * @param [locale] Optional locale name (defaults to empty locale)
      * @example
      * import {HDate, HebrewDateEvent, months} from '@hebcal/core';
      *

package/dist/HolidayEvent.d.ts

@@ -5,7 +5,6 @@ import './locale';
 export declare class HolidayEvent extends Event {
     /** During Sukkot or Pesach */
     cholHaMoedDay?: number;
-    chanukahDay?: number;
     /**
      * `true` if the fast day was postponed a day to avoid Shabbat.
      * - Tish'a B'Av postponed from the 9th to the 10th
@@ -19,21 +18,16 @@ export declare class HolidayEvent extends Event {
     getCategories(): string[];
     /**
      * Returns (translated) description of this event
-     * @param [locale] Optional locale name (defaults to active locale).
+     * @param [locale] Optional locale name (defaults to empty 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 [locale] Optional locale name (defaults to active locale).
+     * @param [locale] Optional locale name (defaults to empty locale)
      */
     renderBrief(locale?: string): string;
-    /**
-     * Makes a clone of this Event object
-     * @deprecated
-     */
-    clone(): HolidayEvent;
 }
 /**
  * Because Asara B'Tevet often occurs twice in the same Gregorian year,
@@ -47,6 +41,11 @@ export declare class AsaraBTevetEvent extends HolidayEvent {
  * we subclass HolidayEvent to generate the correct URL.
  */
 export declare class ChanukahEvent extends HolidayEvent {
+    readonly chanukahDay?: number;
+    /**
+     * @param chanukahDay should be undefined for 1st night of Chanukah
+     */
+    constructor(date: HDate, desc: string, mask: number, chanukahDay?: number);
     urlDateSuffix(): string;
 }
 /** Represents Rosh Hashana, the Jewish New Year */
@@ -61,7 +60,7 @@ export declare class RoshHashanaEvent extends HolidayEvent {
     constructor(date: HDate, hyear: number, mask: number);
     /**
      * Returns (translated) description of this event
-     * @param [locale] Optional locale name (defaults to active locale).
+     * @param [locale] Optional locale name (defaults to empty locale)
      */
     render(locale?: string): string;
     getEmoji(): string;
@@ -76,7 +75,7 @@ export declare class RoshChodeshEvent extends HolidayEvent {
     constructor(date: HDate, monthName: string);
     /**
      * Returns (translated) description of this event
-     * @param [locale] Optional locale name (defaults to active locale).
+     * @param [locale] Optional locale name (defaults to empty locale)
      */
     render(locale?: string): string;
     basename(): string;

package/dist/MevarchimChodeshEvent.d.ts

@@ -15,12 +15,12 @@ export declare class MevarchimChodeshEvent extends Event {
     basename(): string;
     /**
      * Returns (translated) description of this event
-     * @param [locale] Optional locale name (defaults to active locale).
+     * @param [locale] Optional locale name (defaults to empty locale)
      */
     render(locale?: string): string;
     /**
      * Returns (translated) description of this event
-     * @param [locale] Optional locale name (defaults to active locale).
+     * @param [locale] Optional locale name (defaults to empty locale)
      */
     renderBrief(locale?: string): string;
 }

package/dist/ParshaEvent.d.ts

@@ -1,20 +1,14 @@
 import { Event } from './event';
-import { HDate } from '@hebcal/hdate';
+import { SedraResult } from './sedra';
 import './locale';
 /**
  * Represents one of 54 weekly Torah portions, always on a Saturday
  */
 export declare class ParshaEvent extends Event {
-    readonly parsha: string[];
-    readonly il: boolean;
-    readonly num: number | number[];
+    readonly p: SedraResult;
+    constructor(parsha: SedraResult);
     /**
-     * @param parsha - untranslated name of single or double parsha,
-     *   such as ['Bereshit'] or ['Achrei Mot', 'Kedoshim']
-     */
-    constructor(date: HDate, parsha: string[], il?: boolean, num?: number | number[]);
-    /**
-     * @param [locale] Optional locale name (i.e: `'he'`, `'fr'`). Defaults to active locale.
+     * @param [locale] Optional locale name (i.e: `'he'`, `'fr'`). Defaults to empty locale.
      */
     render(locale?: string): string;
     basename(): string;

package/dist/TimedEvent.d.ts

@@ -15,12 +15,12 @@ export declare class TimedEvent extends Event {
      */
     constructor(date: HDate, desc: string, mask: number, eventTime: Date, location: Location, linkedEvent?: Event, options?: CalOptions);
     /**
-     * @param [locale] Optional locale name (defaults to active locale).
+     * @param [locale] Optional locale name (defaults to empty locale)
      */
     render(locale?: string): string;
     /**
      * Returns translation of "Candle lighting" without the time.
-     * @param [locale] Optional locale name (defaults to active locale).
+     * @param [locale] Optional locale name (defaults to empty locale)
      */
     renderBrief(locale?: string): string;
     getCategories(): string[];
@@ -35,12 +35,12 @@ 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 [locale] Optional locale name (defaults to active locale).
+     * @param [locale] Optional locale name (defaults to empty locale)
      */
     render(locale?: string): string;
     /**
      * Returns translation of "Havdalah" without the time.
-     * @param [locale] Optional locale name (defaults to active locale).
+     * @param [locale] Optional locale name (defaults to empty locale)
      */
     renderBrief(locale?: string): string;
     getEmoji(): string;

package/dist/YomKippurKatanEvent.d.ts

@@ -12,11 +12,11 @@ export declare class YomKippurKatanEvent extends HolidayEvent {
     constructor(date: HDate, nextMonthName: string);
     basename(): string;
     /**
-     * @param [locale] Optional locale name (defaults to active locale).
+     * @param [locale] Optional locale name (defaults to empty locale)
      */
     render(locale?: string): string;
     /**
-     * @param [locale] Optional locale name (defaults to active locale).
+     * @param [locale] Optional locale name (defaults to empty locale)
      */
     renderBrief(locale?: string): string;
     url(): string | undefined;

package/dist/ashkenazi.po.d.ts

@@ -17,6 +17,7 @@ declare const _default: {
             "Ki Teitzei": string[];
             "Ki Tisa": string[];
             Matot: string[];
+            "Pesach Shabbat Chol ha-Moed": string[];
             "Purim Katan": string[];
             "Shabbat Chazon": string[];
             "Shabbat HaChodesh": string[];
@@ -41,6 +42,7 @@ declare const _default: {
             "Sukkot V (CH''M)": string[];
             "Sukkot VI (CH''M)": string[];
             "Sukkot VII (Hoshana Raba)": string[];
+            "Sukkot Shabbat Chol ha-Moed": string[];
             "Ta'anit Bechorot": string[];
             "Ta'anit Esther": string[];
             Toldot: string[];