@hebcal/leyning 8.0.1 → 8.1.1

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
@@ -108,6 +108,9 @@ of full kriyah aliyot, special Maftir, special Haftarah</p>
108
108
  <dd><p>Looks up leyning for a given holiday. Returns some
109
109
  of full kriyah aliyot, special Maftir, special Haftarah</p>
110
110
  </dd>
111
+ <dt><a href="#makeLeyningNames">makeLeyningNames(parsha)</a> ⇒ <code><a href="#LeyningNames">LeyningNames</a></code></dt>
112
+ <dd><p>Transliterated English and Hebrew names of this parsha</p>
113
+ </dd>
111
114
  <dt><a href="#getWeekdayReading">getWeekdayReading(parsha)</a> ⇒ <code>Object.&lt;string, Aliyah&gt;</code></dt>
112
115
  <dd><p>Looks up Monday/Thursday aliyot for a regular parsha</p>
113
116
  </dd>
@@ -357,6 +360,17 @@ of full kriyah aliyot, special Maftir, special Haftarah
357
360
  | ev | <code>Event</code> | | the Hebcal event associated with this leyning |
358
361
  | [il] | <code>boolean</code> | <code>false</code> | true if Israel holiday scheme |
359
362
 
363
+ <a name="makeLeyningNames"></a>
364
+
365
+ ## makeLeyningNames(parsha) ⇒ [<code>LeyningNames</code>](#LeyningNames)
366
+ Transliterated English and Hebrew names of this parsha
367
+
368
+ **Kind**: global function
369
+
370
+ | Param | Type | Description |
371
+ | --- | --- | --- |
372
+ | parsha | <code>string</code> \| <code>Array.&lt;string&gt;</code> | untranslated name like 'Pinchas' or ['Pinchas'] or ['Matot','Masei'] |
373
+
360
374
  <a name="getWeekdayReading"></a>
361
375
 
362
376
  ## getWeekdayReading(parsha) ⇒ <code>Object.&lt;string, Aliyah&gt;</code>
@@ -501,7 +515,7 @@ Leyning for a parsha hashavua or holiday
501
515
  | --- | --- | --- |
502
516
  | name | [<code>LeyningNames</code>](#LeyningNames) | |
503
517
  | [parsha] | <code>Array.&lt;string&gt;</code> | An array of either 1 (regular) or 2 (doubled parsha). `undefined` for holiday readings |
504
- | [parshaNum] | <code>number</code> | 1 for Bereshit, 2 for Noach, etc. `undefined` for holiday readings |
518
+ | [parshaNum] | <code>number</code> \| <code>Array.&lt;number&gt;</code> | 1 for Bereshit, 2 for Noach, etc. `undefined` for holiday readings |
505
519
  | summary | <code>string</code> | Such as `Genesis 1:1 - 6:8` |
506
520
  | haft | [<code>Aliyah</code>](#Aliyah) \| [<code>Array.&lt;Aliyah&gt;</code>](#Aliyah) | Haftarah object(s) |
507
521
  | haftara | <code>string</code> | Haftarah, such as `Isaiah 42:5 – 43:11` |