diff --git a/README.md b/README.md index 25a8ee1..7384dff 100644 --- a/README.md +++ b/README.md @@ -69,7 +69,7 @@ for (const [num, aliyah] of Object.entries(triReading)) { ## Constants
-
BOOK
+
BOOK : Array.<string>

Names of the books of the Torah. BOOK[1] === 'Genesis'

@@ -77,20 +77,16 @@ for (const [num, aliyah] of Object.entries(triReading)) { ## Functions
-
addSefariaLinksToLeyning(aliyot, showBook)
-

Makes Sefaria links by adding href, verses and num attributes to each aliyah. -CAUTION: Modifies the aliyot parameter instead of making a copy.

-
formatAliyahWithBook(a)string

Formats an aliyah object like "Numbers 28:9-28:15"

formatAliyahShort(aliyah, showBook)string

Formats an aliyah object like "Numbers 28:9-15"

-
getLeyningKeyForEvent(e, [il])string
+
getLeyningKeyForEvent(ev, [il])string

Based on the event date, type and title, finds the relevant leyning key

-
getLeyningForHoliday(e, [il])Leyning
+
getLeyningForHoliday(ev, [il])Leyning

Looks up leyning for a given holiday. Returns some of full kriyah aliyot, special Maftir, special Haftarah

@@ -121,7 +117,7 @@ Parashat haShavua, containing only the weekday aliyot (no ful
getTriennial(year)Triennial

Calculates the 3-year readings for a given year

-
getTriennialForParshaHaShavua(ev, [context])TriennialAliyot | Object.<string, Aliyah>
+
getTriennialForParshaHaShavua(ev)TriennialAliyot

Looks up the triennial leyning for this Parashat HaShavua

getTriennialHaftaraForHoliday(key, yearNum)Object
@@ -216,25 +212,11 @@ Returns Hebrew year that this 3-year triennial cycle began -## BOOK +## BOOK : Array.<string> Names of the books of the Torah. BOOK[1] === 'Genesis' **Kind**: global constant - - -## ~~addSefariaLinksToLeyning(aliyot, showBook)~~ -***Deprecated*** - -Makes Sefaria links by adding `href`, `verses` and `num` attributes to each aliyah. -CAUTION: Modifies the `aliyot` parameter instead of making a copy. - -**Kind**: global function - -| Param | Type | Description | -| --- | --- | --- | -| aliyot | Object.<string, Aliyah> | aliyah map to decorate | -| showBook | boolean | display the book name in the `verses` field (e.g. for special Maftir) | - +**Read only**: true ## formatAliyahWithBook(a) ⇒ string @@ -260,7 +242,7 @@ Formats an aliyah object like "Numbers 28:9-15" -## getLeyningKeyForEvent(e, [il]) ⇒ string +## getLeyningKeyForEvent(ev, [il]) ⇒ string Based on the event date, type and title, finds the relevant leyning key **Kind**: global function @@ -268,12 +250,12 @@ Based on the event date, type and title, finds the relevant leyning key | Param | Type | Default | Description | | --- | --- | --- | --- | -| e | Event | | event | +| ev | Event | | event | | [il] | boolean | false | true if Israel holiday scheme | -## getLeyningForHoliday(e, [il]) ⇒ [Leyning](#Leyning) +## getLeyningForHoliday(ev, [il]) ⇒ [Leyning](#Leyning) Looks up leyning for a given holiday. Returns some of full kriyah aliyot, special Maftir, special Haftarah @@ -282,7 +264,7 @@ of full kriyah aliyot, special Maftir, special Haftarah | Param | Type | Default | Description | | --- | --- | --- | --- | -| e | Event | | the Hebcal event associated with this leyning | +| ev | Event | | the Hebcal event associated with this leyning | | [il] | boolean | false | true if Israel holiday scheme | @@ -377,16 +359,15 @@ Calculates the 3-year readings for a given year -## getTriennialForParshaHaShavua(ev, [context]) ⇒ [TriennialAliyot](#TriennialAliyot) \| Object.<string, Aliyah> +## getTriennialForParshaHaShavua(ev) ⇒ [TriennialAliyot](#TriennialAliyot) Looks up the triennial leyning for this Parashat HaShavua **Kind**: global function -**Returns**: [TriennialAliyot](#TriennialAliyot) \| Object.<string, Aliyah> - a map of aliyot 1-7 plus "M" +**Returns**: [TriennialAliyot](#TriennialAliyot) - a map of aliyot 1-7 plus "M" -| Param | Type | Default | Description | -| --- | --- | --- | --- | -| ev | Event | | | -| [context] | boolean | false | returns a reading wrapper object which includes `date`, `yearNum` and `aliyot` | +| Param | Type | +| --- | --- | +| ev | Event |