@hebcal/core 5.5.2 → 5.6.1

package/dist/module.d.ts

@@ -4,7 +4,7 @@ import { GeoLocation } from '@hebcal/noaa';
 export { GeoLocation, NOAACalculator } from '@hebcal/noaa';
 
 /** DO NOT EDIT THIS AUTO-GENERATED FILE! */
-declare const version = "5.5.2";
+declare const version = "5.6.1";
 
 /** Class representing Location */
 declare class Location extends GeoLocation {
@@ -964,6 +964,8 @@ type SedraResult = {
      * *Matot-Masei* it would be `[42, 43]`
      */
     num?: number | number[];
+    /** The date of the Shabbat this parsha is read */
+    hdate: HDate;
 };
 /**
  * Represents Parashah HaShavua for an entire Hebrew year
@@ -981,11 +983,13 @@ declare class Sedra {
     constructor(hyear: number, il: boolean);
     /**
      * Returns the parsha (or parshiyot) read on Hebrew date
+     * @deprecated Use {@link lookup} instead
      * @param hd Hebrew date or R.D. days
      */
     get(hd: HDate | number): string[];
     /**
      * Looks up parsha for the date, then returns a translated or transliterated string
+     * @deprecated Use {@link lookup} instead
      * @param hd Hebrew date or R.D. days
      * @param [locale] Optional locale name (i.e: `'he'`, `'fr'`). Defaults to active locale
      */
@@ -993,14 +997,25 @@ declare class Sedra {
     /**
      * Checks to see if this day would be a regular parasha HaShavua
      * Torah reading or special holiday reading
+     * @deprecated Use {@link lookup} instead
      * @param hd Hebrew date or R.D. days
      */
     isParsha(hd: HDate | number): boolean;
     /**
      * Returns the date that a parsha occurs
      * or `null` if the parsha doesn't occur this year
+     * @param parsha if a `string`, specified with Sephardic transliterations
+     *  like `'Noach'` or `'Matot-Masei'`. If an array, must be a 1- or 2-element
+     *  array such as `['Noach']` or `['Matot', 'Masei']`. If a `number`, should
+     *  be a 0-based parsha index (`0` for Bereshit, `1` for Noach) or a negative
+     *  number for a doubled parsha (e.g. `-21` for Vayakhel-Pekudei)
      */
     find(parsha: number | string | string[]): HDate | null;
+    /**
+     * Returns the date that a parsha (or its doubled or undoubled counterpart)
+     * occurs, or `null` if the parsha doesn't occur this year
+     */
+    findContaining(parsha: number | string): HDate | null;
     /**
      * Returns the underlying annual sedra schedule.
      * Used by `@hebcal/triennial`
@@ -1018,7 +1033,7 @@ declare class Sedra {
     lookup(hd: HDate | number): SedraResult;
 }
 /**
- * The 54 parshiyot of the Torah as transilterated strings
+ * The 54 parshiyot of the Torah as transilterated strings.
  * parshiot[0] == 'Bereshit', parshiot[1] == 'Noach', parshiot[52] == "Ha'azinu".
  * @readonly
  * @type {string[]}

package/dist/parshaName.d.ts

@@ -0,0 +1,3 @@
+import './locale';
+/** @private */
+export declare function renderParshaName(parsha: string[], locale?: string): string;

package/dist/pkgVersion.d.ts

@@ -1,2 +1,2 @@
 /** DO NOT EDIT THIS AUTO-GENERATED FILE! */
-export declare const version = "5.5.2";
+export declare const version = "5.6.1";

package/dist/sedra.d.ts

@@ -20,6 +20,8 @@ export type SedraResult = {
      * *Matot-Masei* it would be `[42, 43]`
      */
     num?: number | number[];
+    /** The date of the Shabbat this parsha is read */
+    hdate: HDate;
 };
 /**
  * Represents Parashah HaShavua for an entire Hebrew year
@@ -37,11 +39,13 @@ export declare class Sedra {
     constructor(hyear: number, il: boolean);
     /**
      * Returns the parsha (or parshiyot) read on Hebrew date
+     * @deprecated Use {@link lookup} instead
      * @param hd Hebrew date or R.D. days
      */
     get(hd: HDate | number): string[];
     /**
      * Looks up parsha for the date, then returns a translated or transliterated string
+     * @deprecated Use {@link lookup} instead
      * @param hd Hebrew date or R.D. days
      * @param [locale] Optional locale name (i.e: `'he'`, `'fr'`). Defaults to active locale
      */
@@ -49,14 +53,25 @@ export declare class Sedra {
     /**
      * Checks to see if this day would be a regular parasha HaShavua
      * Torah reading or special holiday reading
+     * @deprecated Use {@link lookup} instead
      * @param hd Hebrew date or R.D. days
      */
     isParsha(hd: HDate | number): boolean;
     /**
      * Returns the date that a parsha occurs
      * or `null` if the parsha doesn't occur this year
+     * @param parsha if a `string`, specified with Sephardic transliterations
+     *  like `'Noach'` or `'Matot-Masei'`. If an array, must be a 1- or 2-element
+     *  array such as `['Noach']` or `['Matot', 'Masei']`. If a `number`, should
+     *  be a 0-based parsha index (`0` for Bereshit, `1` for Noach) or a negative
+     *  number for a doubled parsha (e.g. `-21` for Vayakhel-Pekudei)
      */
     find(parsha: number | string | string[]): HDate | null;
+    /**
+     * Returns the date that a parsha (or its doubled or undoubled counterpart)
+     * occurs, or `null` if the parsha doesn't occur this year
+     */
+    findContaining(parsha: number | string): HDate | null;
     /**
      * Returns the underlying annual sedra schedule.
      * Used by `@hebcal/triennial`
@@ -74,7 +89,7 @@ export declare class Sedra {
     lookup(hd: HDate | number): SedraResult;
 }
 /**
- * The 54 parshiyot of the Torah as transilterated strings
+ * The 54 parshiyot of the Torah as transilterated strings.
  * parshiot[0] == 'Bereshit', parshiot[1] == 'Noach', parshiot[52] == "Ha'azinu".
  * @readonly
  * @type {string[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hebcal/core",
-  "version": "5.5.2",
+  "version": "5.6.1",
   "author": "Michael J. Radwin (https://github.com/mjradwin)",
   "contributors": [
     "Eyal Schachter (https://github.com/Scimonster)",
@@ -67,31 +67,31 @@
     "temporal-polyfill": "^0.2.5"
   },
   "devDependencies": {
-    "@babel/core": "^7.25.7",
-    "@babel/preset-env": "^7.25.7",
-    "@babel/preset-typescript": "^7.25.7",
-    "@babel/register": "^7.25.7",
+    "@babel/core": "^7.26.0",
+    "@babel/preset-env": "^7.26.0",
+    "@babel/preset-typescript": "^7.26.0",
+    "@babel/register": "^7.25.9",
     "@rollup/plugin-babel": "^6.0.4",
-    "@rollup/plugin-commonjs": "^28.0.0",
+    "@rollup/plugin-commonjs": "^28.0.1",
     "@rollup/plugin-json": "^6.1.0",
     "@rollup/plugin-node-resolve": "^15.3.0",
     "@rollup/plugin-terser": "^0.4.4",
-    "@rollup/plugin-typescript": "^12.1.0",
-    "@types/jest": "^29.5.13",
-    "@types/node": "^22.7.4",
-    "core-js": "^3.38.1",
-    "gts": "^5.3.1",
+    "@rollup/plugin-typescript": "^12.1.1",
+    "@types/jest": "^29.5.14",
+    "@types/node": "^22.8.7",
+    "core-js": "^3.39.0",
+    "gts": "^6.0.2",
     "jest": "^29.7.0",
     "quick-lru": "<=6.1.2",
-    "rollup": "^4.24.0",
+    "rollup": "^4.24.3",
     "rollup-plugin-dts": "^6.1.1",
     "ttag-cli": "^1.10.12",
-    "typedoc": "^0.26.8",
-    "typescript": "^5.6.2"
+    "typedoc": "^0.26.11",
+    "typescript": "^5.6.3"
   },
   "dependencies": {
-    "@hebcal/hdate": "^0.11.4",
+    "@hebcal/hdate": "^0.11.5",
     "@hebcal/noaa": "^0.8.14",
-    "tslib": "^2.7.0"
+    "tslib": "^2.8.1"
   }
 }