@hebcal/leyning 4.18.2 → 4.20.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 CHANGED
@@ -135,6 +135,9 @@ Parashat haShavua, containing only the <code>weekday</code> aliyot (no <code>ful
135
135
  <dt><a href="#Aliyah">Aliyah</a> : <code>Object</code></dt>
136
136
  <dd><p>Represents an aliyah</p>
137
137
  </dd>
138
+ <dt><a href="#LeyningNames">LeyningNames</a> : <code>Object</code></dt>
139
+ <dd><p>Name of the parsha hashavua or holiday</p>
140
+ </dd>
138
141
  <dt><a href="#Leyning">Leyning</a> : <code>Object</code></dt>
139
142
  <dd><p>Leyning for a parsha hashavua or holiday</p>
140
143
  </dd>
@@ -413,6 +416,19 @@ Represents an aliyah
413
416
  | [v] | <code>number</code> | number of verses |
414
417
  | [p] | <code>number</code> | parsha number (1=Bereshit, 54=Vezot HaBracha) |
415
418
 
419
+ <a name="LeyningNames"></a>
420
+
421
+ ## LeyningNames : <code>Object</code>
422
+ Name of the parsha hashavua or holiday
423
+
424
+ **Kind**: global typedef
425
+ **Properties**
426
+
427
+ | Name | Type | Description |
428
+ | --- | --- | --- |
429
+ | en | <code>string</code> | English |
430
+ | he | <code>string</code> | Hebrew (with nikud) |
431
+
416
432
  <a name="Leyning"></a>
417
433
 
418
434
  ## Leyning : <code>Object</code>
@@ -423,16 +439,19 @@ Leyning for a parsha hashavua or holiday
423
439
 
424
440
  | Name | Type | Description |
425
441
  | --- | --- | --- |
426
- | summary | <code>string</code> | |
427
- | haft | [<code>Aliyah</code>](#Aliyah) | Haftarah |
428
- | haftara | <code>string</code> | Haftarah |
429
- | [haftaraNumV] | <code>number</code> | |
430
- | [seph] | [<code>Aliyah</code>](#Aliyah) | Haftarah for Sephardic |
431
- | [sephardic] | <code>string</code> | Haftarah for Sephardic |
432
- | [sephardicNumV] | <code>number</code> | |
433
- | fullkriyah | <code>Object.&lt;string, Aliyah&gt;</code> | |
434
- | [weekday] | <code>Object.&lt;string, Aliyah&gt;</code> | |
435
- | [reason] | <code>Object</code> | |
442
+ | name | [<code>LeyningNames</code>](#LeyningNames) | |
443
+ | [parsha] | <code>Array.&lt;string&gt;</code> | An array of either 1 (regular) or 2 (doubled parsha). `undefined` for holiday readings |
444
+ | [parshaNum] | <code>num</code> | 1 for Bereshit, 2 for Noach, etc. `undefined` for holiday readings |
445
+ | summary | <code>string</code> | Such as `Genesis 1:1 - 6:8` |
446
+ | haft | [<code>Aliyah</code>](#Aliyah) \| [<code>Array.&lt;Aliyah&gt;</code>](#Aliyah) | Haftarah object(s) |
447
+ | haftara | <code>string</code> | Haftarah, such as `Isaiah 42:5 – 43:11` |
448
+ | [haftaraNumV] | <code>number</code> | Number of verses in the Haftarah |
449
+ | [seph] | [<code>Aliyah</code>](#Aliyah) \| [<code>Array.&lt;Aliyah&gt;</code>](#Aliyah) | Haftarah object(s) for Sephardim |
450
+ | [sephardic] | <code>string</code> | Haftarah for Sephardim, such as `Isaiah 42:5 - 42:21` |
451
+ | [sephardicNumV] | <code>number</code> | Number of verses in the Haftarah for Sephardim |
452
+ | fullkriyah | <code>Object.&lt;string, Aliyah&gt;</code> | Map of aliyot `1` through `7` plus `M` for maftir |
453
+ | [weekday] | <code>Object.&lt;string, Aliyah&gt;</code> | Optional map of weekday Torah Readings aliyot `1` through `3` for Monday and Thursday |
454
+ | [reason] | <code>Object.&lt;string, string&gt;</code> | Explanations for special readings, keyed by aliyah number, `M` for maftir or `haftara` for Haftarah |
436
455
 
437
456
  <a name="TriennialAliyot"></a>
438
457