@hebcal/leyning 4.15.2 → 4.18.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/README.md +32 -0
- package/dist/bundle.js +496 -434
- package/dist/bundle.min.js +2 -2
- package/dist/index.js +220 -180
- package/dist/index.mjs +221 -181
- package/leyning.d.ts +9 -1
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -23,6 +23,7 @@ the third section of the parashah.
|
|
|
23
23
|
|
|
24
24
|
[Modification of the Triennial Cycle Readings for Combined Parashot in Certain Years](https://www.rabbinicalassembly.org/sites/default/files/2021-09/cohen-triennial.pdf), Rabbi Miles B. Cohen
|
|
25
25
|
|
|
26
|
+
Update August 2022: Incorporated [An Emendation to Richard Eisenberg’s Complete Triennial System for Reading Torah, to Address a Rare Situation](https://www.rabbinicalassembly.org/sites/default/files/public/halakhah/teshuvot/2011-2020/heller-triennial-emendation.pdf), Rabbi Joshua Heller, 2012
|
|
26
27
|
|
|
27
28
|
## Installation
|
|
28
29
|
```bash
|
|
@@ -107,12 +108,18 @@ of full kriyah aliyot, special Maftir, special Haftarah</p>
|
|
|
107
108
|
<dt><a href="#getLeyningForParshaHaShavua">getLeyningForParshaHaShavua(ev, [il])</a> ⇒ <code><a href="#Leyning">Leyning</a></code></dt>
|
|
108
109
|
<dd><p>Looks up leyning for a regular Shabbat parsha.</p>
|
|
109
110
|
</dd>
|
|
111
|
+
<dt><a href="#getLeyningOnDate">getLeyningOnDate(hdate, il)</a> ⇒ <code><a href="#Leyning">Leyning</a></code></dt>
|
|
112
|
+
<dd><p>Looks up leyning for a regular Shabbat or holiday</p>
|
|
113
|
+
</dd>
|
|
110
114
|
<dt><a href="#getTriennial">getTriennial(year)</a> ⇒ <code><a href="#Triennial">Triennial</a></code></dt>
|
|
111
115
|
<dd><p>Calculates the 3-year readings for a given year</p>
|
|
112
116
|
</dd>
|
|
113
117
|
<dt><a href="#getTriennialForParshaHaShavua">getTriennialForParshaHaShavua(ev, [context])</a> ⇒ <code><a href="#TriennialAliyot">TriennialAliyot</a></code> | <code>Object.<string, Aliyah></code></dt>
|
|
114
118
|
<dd><p>Looks up the triennial leyning for this Parashat HaShavua</p>
|
|
115
119
|
</dd>
|
|
120
|
+
<dt><a href="#getTriennialHaftaraForHoliday">getTriennialHaftaraForHoliday(key, yearNum)</a> ⇒ <code>Object</code></dt>
|
|
121
|
+
<dd><p>Looks up the alternative triennial Haftara for a holiday</p>
|
|
122
|
+
</dd>
|
|
116
123
|
</dl>
|
|
117
124
|
|
|
118
125
|
## Typedefs
|
|
@@ -323,6 +330,19 @@ Looks up leyning for a regular Shabbat parsha.
|
|
|
323
330
|
| ev | <code>Event</code> | | the Hebcal event associated with this leyning |
|
|
324
331
|
| [il] | <code>boolean</code> | <code>false</code> | in Israel |
|
|
325
332
|
|
|
333
|
+
<a name="getLeyningOnDate"></a>
|
|
334
|
+
|
|
335
|
+
## getLeyningOnDate(hdate, il) ⇒ [<code>Leyning</code>](#Leyning)
|
|
336
|
+
Looks up leyning for a regular Shabbat or holiday
|
|
337
|
+
|
|
338
|
+
**Kind**: global function
|
|
339
|
+
**Returns**: [<code>Leyning</code>](#Leyning) - map of aliyot
|
|
340
|
+
|
|
341
|
+
| Param | Type | Description |
|
|
342
|
+
| --- | --- | --- |
|
|
343
|
+
| hdate | <code>HDate</code> | Hebrew Date |
|
|
344
|
+
| il | <code>boolean</code> | in Israel |
|
|
345
|
+
|
|
326
346
|
<a name="getTriennial"></a>
|
|
327
347
|
|
|
328
348
|
## getTriennial(year) ⇒ [<code>Triennial</code>](#Triennial)
|
|
@@ -347,6 +367,18 @@ Looks up the triennial leyning for this Parashat HaShavua
|
|
|
347
367
|
| ev | <code>Event</code> | | |
|
|
348
368
|
| [context] | <code>boolean</code> | <code>false</code> | returns a reading wrapper object which includes `date`, `yearNum` and `aliyot` |
|
|
349
369
|
|
|
370
|
+
<a name="getTriennialHaftaraForHoliday"></a>
|
|
371
|
+
|
|
372
|
+
## getTriennialHaftaraForHoliday(key, yearNum) ⇒ <code>Object</code>
|
|
373
|
+
Looks up the alternative triennial Haftara for a holiday
|
|
374
|
+
|
|
375
|
+
**Kind**: global function
|
|
376
|
+
|
|
377
|
+
| Param | Type |
|
|
378
|
+
| --- | --- |
|
|
379
|
+
| key | <code>string</code> |
|
|
380
|
+
| yearNum | <code>number</code> |
|
|
381
|
+
|
|
350
382
|
<a name="Aliyah"></a>
|
|
351
383
|
|
|
352
384
|
## Aliyah : <code>Object</code>
|