@hebcal/core 5.5.2 → 5.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/module.d.ts CHANGED
@@ -4,7 +4,7 @@ import { GeoLocation } from '@hebcal/noaa';
4
4
  export { GeoLocation, NOAACalculator } from '@hebcal/noaa';
5
5
 
6
6
  /** DO NOT EDIT THIS AUTO-GENERATED FILE! */
7
- declare const version = "5.5.2";
7
+ declare const version = "5.6.0";
8
8
 
9
9
  /** Class representing Location */
10
10
  declare class Location extends GeoLocation {
@@ -964,6 +964,8 @@ type SedraResult = {
964
964
  * *Matot-Masei* it would be `[42, 43]`
965
965
  */
966
966
  num?: number | number[];
967
+ /** The date of the Shabbat this parsha is read */
968
+ hdate: HDate;
967
969
  };
968
970
  /**
969
971
  * Represents Parashah HaShavua for an entire Hebrew year
@@ -981,11 +983,13 @@ declare class Sedra {
981
983
  constructor(hyear: number, il: boolean);
982
984
  /**
983
985
  * Returns the parsha (or parshiyot) read on Hebrew date
986
+ * @deprecated Use {@link lookup} instead
984
987
  * @param hd Hebrew date or R.D. days
985
988
  */
986
989
  get(hd: HDate | number): string[];
987
990
  /**
988
991
  * Looks up parsha for the date, then returns a translated or transliterated string
992
+ * @deprecated Use {@link lookup} instead
989
993
  * @param hd Hebrew date or R.D. days
990
994
  * @param [locale] Optional locale name (i.e: `'he'`, `'fr'`). Defaults to active locale
991
995
  */
@@ -993,6 +997,7 @@ declare class Sedra {
993
997
  /**
994
998
  * Checks to see if this day would be a regular parasha HaShavua
995
999
  * Torah reading or special holiday reading
1000
+ * @deprecated Use {@link lookup} instead
996
1001
  * @param hd Hebrew date or R.D. days
997
1002
  */
998
1003
  isParsha(hd: HDate | number): boolean;
@@ -1001,6 +1006,11 @@ declare class Sedra {
1001
1006
  * or `null` if the parsha doesn't occur this year
1002
1007
  */
1003
1008
  find(parsha: number | string | string[]): HDate | null;
1009
+ /**
1010
+ * Returns the date that a parsha (or its doubled or undoubled counterpart)
1011
+ * occurs, or `null` if the parsha doesn't occur this year
1012
+ */
1013
+ findContaining(parsha: number | string): HDate | null;
1004
1014
  /**
1005
1015
  * Returns the underlying annual sedra schedule.
1006
1016
  * Used by `@hebcal/triennial`
@@ -1018,7 +1028,7 @@ declare class Sedra {
1018
1028
  lookup(hd: HDate | number): SedraResult;
1019
1029
  }
1020
1030
  /**
1021
- * The 54 parshiyot of the Torah as transilterated strings
1031
+ * The 54 parshiyot of the Torah as transilterated strings.
1022
1032
  * parshiot[0] == 'Bereshit', parshiot[1] == 'Noach', parshiot[52] == "Ha'azinu".
1023
1033
  * @readonly
1024
1034
  * @type {string[]}
@@ -0,0 +1,3 @@
1
+ import './locale';
2
+ /** @private */
3
+ export declare function renderParshaName(parsha: string[], locale?: string): string;
@@ -1,2 +1,2 @@
1
1
  /** DO NOT EDIT THIS AUTO-GENERATED FILE! */
2
- export declare const version = "5.5.2";
2
+ export declare const version = "5.6.0";
package/dist/sedra.d.ts CHANGED
@@ -20,6 +20,8 @@ export type SedraResult = {
20
20
  * *Matot-Masei* it would be `[42, 43]`
21
21
  */
22
22
  num?: number | number[];
23
+ /** The date of the Shabbat this parsha is read */
24
+ hdate: HDate;
23
25
  };
24
26
  /**
25
27
  * Represents Parashah HaShavua for an entire Hebrew year
@@ -37,11 +39,13 @@ export declare class Sedra {
37
39
  constructor(hyear: number, il: boolean);
38
40
  /**
39
41
  * Returns the parsha (or parshiyot) read on Hebrew date
42
+ * @deprecated Use {@link lookup} instead
40
43
  * @param hd Hebrew date or R.D. days
41
44
  */
42
45
  get(hd: HDate | number): string[];
43
46
  /**
44
47
  * Looks up parsha for the date, then returns a translated or transliterated string
48
+ * @deprecated Use {@link lookup} instead
45
49
  * @param hd Hebrew date or R.D. days
46
50
  * @param [locale] Optional locale name (i.e: `'he'`, `'fr'`). Defaults to active locale
47
51
  */
@@ -49,6 +53,7 @@ export declare class Sedra {
49
53
  /**
50
54
  * Checks to see if this day would be a regular parasha HaShavua
51
55
  * Torah reading or special holiday reading
56
+ * @deprecated Use {@link lookup} instead
52
57
  * @param hd Hebrew date or R.D. days
53
58
  */
54
59
  isParsha(hd: HDate | number): boolean;
@@ -57,6 +62,11 @@ export declare class Sedra {
57
62
  * or `null` if the parsha doesn't occur this year
58
63
  */
59
64
  find(parsha: number | string | string[]): HDate | null;
65
+ /**
66
+ * Returns the date that a parsha (or its doubled or undoubled counterpart)
67
+ * occurs, or `null` if the parsha doesn't occur this year
68
+ */
69
+ findContaining(parsha: number | string): HDate | null;
60
70
  /**
61
71
  * Returns the underlying annual sedra schedule.
62
72
  * Used by `@hebcal/triennial`
@@ -74,7 +84,7 @@ export declare class Sedra {
74
84
  lookup(hd: HDate | number): SedraResult;
75
85
  }
76
86
  /**
77
- * The 54 parshiyot of the Torah as transilterated strings
87
+ * The 54 parshiyot of the Torah as transilterated strings.
78
88
  * parshiot[0] == 'Bereshit', parshiot[1] == 'Noach', parshiot[52] == "Ha'azinu".
79
89
  * @readonly
80
90
  * @type {string[]}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@hebcal/core",
3
- "version": "5.5.2",
3
+ "version": "5.6.0",
4
4
  "author": "Michael J. Radwin (https://github.com/mjradwin)",
5
5
  "contributors": [
6
6
  "Eyal Schachter (https://github.com/Scimonster)",
@@ -67,31 +67,31 @@
67
67
  "temporal-polyfill": "^0.2.5"
68
68
  },
69
69
  "devDependencies": {
70
- "@babel/core": "^7.25.7",
71
- "@babel/preset-env": "^7.25.7",
72
- "@babel/preset-typescript": "^7.25.7",
73
- "@babel/register": "^7.25.7",
70
+ "@babel/core": "^7.26.0",
71
+ "@babel/preset-env": "^7.26.0",
72
+ "@babel/preset-typescript": "^7.26.0",
73
+ "@babel/register": "^7.25.9",
74
74
  "@rollup/plugin-babel": "^6.0.4",
75
- "@rollup/plugin-commonjs": "^28.0.0",
75
+ "@rollup/plugin-commonjs": "^28.0.1",
76
76
  "@rollup/plugin-json": "^6.1.0",
77
77
  "@rollup/plugin-node-resolve": "^15.3.0",
78
78
  "@rollup/plugin-terser": "^0.4.4",
79
- "@rollup/plugin-typescript": "^12.1.0",
80
- "@types/jest": "^29.5.13",
81
- "@types/node": "^22.7.4",
82
- "core-js": "^3.38.1",
83
- "gts": "^5.3.1",
79
+ "@rollup/plugin-typescript": "^12.1.1",
80
+ "@types/jest": "^29.5.14",
81
+ "@types/node": "^22.8.4",
82
+ "core-js": "^3.39.0",
83
+ "gts": "^6.0.2",
84
84
  "jest": "^29.7.0",
85
85
  "quick-lru": "<=6.1.2",
86
- "rollup": "^4.24.0",
86
+ "rollup": "^4.24.3",
87
87
  "rollup-plugin-dts": "^6.1.1",
88
88
  "ttag-cli": "^1.10.12",
89
- "typedoc": "^0.26.8",
90
- "typescript": "^5.6.2"
89
+ "typedoc": "^0.26.10",
90
+ "typescript": "^5.6.3"
91
91
  },
92
92
  "dependencies": {
93
- "@hebcal/hdate": "^0.11.4",
93
+ "@hebcal/hdate": "^0.11.5",
94
94
  "@hebcal/noaa": "^0.8.14",
95
- "tslib": "^2.7.0"
95
+ "tslib": "^2.8.0"
96
96
  }
97
97
  }