@hebcal/leyning

v8.1.9

Published

10 days ago

Torah Reading API for Parashat HaShavua and holidays

Downloads

380

0High
0Medium
0Low

mjradwin

hebcal torah sedra sedrot leyning kriyah leining sidra parsha parasha parashah

@hebcal/leyning

Javascript Torah Reading API for Parashat HaShavua and holidays

This package includes both traditional (full kriyah) and weekday Torah readings.

Triennial Torah Readings have moved to @hebcal/triennial

Installation

$ npm install @hebcal/leyning

Synopsis

import {HebrewCalendar, HDate, Event} from '@hebcal/core';
import {getLeyningForParshaHaShavua, formatAliyahWithBook} from '@hebcal/leyning';

const events = HebrewCalendar.calendar({sedrot: true, noHolidays: true});
const ev = events.find((ev) => ev.getDesc() == 'Parashat Pinchas');
const reading = getLeyningForParshaHaShavua(ev, false);
console.log(`${ev.getDesc()}: ${reading.summary}`);
console.log(`Haftara: ${reading.haftara}`);
for (const [num, aliyah] of Object.entries(reading.fullkriyah)) {
  const number = num == 'M' ? 'maftir' : `aliyah ${num}`;
  let str = formatAliyahWithBook(aliyah);
  if (reading.reason[num]) {
      str += ' | ' + reading.reason[num];
  }
  str += ` (${aliyah.v} verses)`;
  console.log(`${number}: ${str}`);
}

Constants

Functions

Typedefs

BOOK : Array.<string>

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

Kind: global constant
Read only: true

parshaToString(parsha) ⇒ string

Formats parsha as a string

Kind: global function

| Param | Type | Description | | --- | --- | --- | | parsha | string | Array.<string> | untranslated name like 'Pinchas' or ['Pinchas'] or ['Matot','Masei'] |

clone(src) ⇒ any

Makes a deep copy of the src object using JSON stringify and parse

Kind: global function

| Param | Type | | --- | --- | | src | any |

calculateNumVerses(aliyah) ⇒ number

Calculates the number of verses in an aliyah or haftara based on the b (begin verse), e (end verse) and k (book). Modifies aliyah by setting the v field.

Kind: global function

| Param | Type | | --- | --- | | aliyah | Aliyah |

formatAliyahWithBook(a) ⇒ string

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

Kind: global function

| Param | Type | Description | | --- | --- | --- | | a | Aliyah | aliyah |

formatAliyahShort(aliyah, showBook) ⇒ string

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

Kind: global function

| Param | Type | | --- | --- | | aliyah | Aliyah | | showBook | boolean |

sumVerses(aliyot) ⇒ number

Returns the total number of verses in an array of Aliyah (or haftarah) objects

Kind: global function

| Param | Type | | --- | --- | | aliyot | Aliyah | Array.<Aliyah> |

makeLeyningParts(aliyot) ⇒ Array.<Aliyah>

Summarizes an AliyotMap by collapsing all adjacent aliyot. Finds any non-overlapping parts (e.g. special 7th aliyah or maftir)

Kind: global function

| Param | Type | | --- | --- | | aliyot | Object.<string, Aliyah> |

makeSummaryFromParts(parts) ⇒ string

Returns a string representation of the leyning parts. Separate verse ranges read from the same book are separated by commas, e.g. Isaiah 6:1-7:6, 9:5-6. Verse ranges from different books are separated by semicolons, e.g. Genesis 21:1-34; Numbers 29:1-6.

Kind: global function

| Param | Type | | --- | --- | | parts | Aliyah | Array.<Aliyah> |

makeLeyningSummary(aliyot) ⇒ string

Makes a summary of the leyning, like "Genesis 6:9-11:32"

Kind: global function

| Param | Type | | --- | --- | | aliyot | Object.<string, Aliyah> |

hasFestival(holiday) ⇒ boolean

Is there a special festival Torah Reading for holiday?

Kind: global function

| Param | Type | | --- | --- | | holiday | string |

lookupFestival(holiday) ⇒ any

Returns the raw metadata for festival reading for holiday

Kind: global function

| Param | Type | | --- | --- | | holiday | string |

getLeyningKeyForEvent(ev, [il]) ⇒ string

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

Kind: global function
Returns: string - key to look up in holiday-reading.json

| Param | Type | Default | Description | | --- | --- | --- | --- | | ev | Event | | event | | [il] | boolean | false | true if Israel holiday scheme |

specialReadings2(parsha, hd, il, aliyot) ⇒ SpecialReading

Determines if the regular parashat haShavua coincides with an event that requires a special maftir or Haftara (for example Shabbat HaGadol, Shabbat Chanukah, Rosh Chodesh or Machar Chodesh, etc.).

This function does not modify aliyot. Instead, it returns a deep copy with aliyot['M'] replaced and sets reason.M (and in some cases the 6th and 7th aliyah, setting reason['7']).

If a special Haftarah applies, the result will have a haft property pointing to Haftarah object and sets reason.haftara.

Kind: global function

| Param | Type | | --- | --- | | parsha | Array.<string> | | hd | HDate | | il | boolean | | aliyot | Object.<string, Aliyah> |

getLeyningForHolidayKey(key, [cholHaMoedDay], [il]) ⇒ Leyning

Looks up leyning for a given holiday key. Key should be an (untranslated) string used in holiday-readings.json. Returns some of full kriyah aliyot, special Maftir, special Haftarah

Kind: global function
Returns: Leyning - map of aliyot

| Param | Type | Description | | --- | --- | --- | | key | string | name from holiday-readings.json to find | | [cholHaMoedDay] | number | | | [il] | boolean | |

getLeyningForHoliday(ev, [il]) ⇒ Leyning

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

Kind: global function
Returns: Leyning - map of aliyot

| Param | Type | Default | Description | | --- | --- | --- | --- | | ev | Event | | the Hebcal event associated with this leyning | | [il] | boolean | false | true if Israel holiday scheme |

makeLeyningNames(parsha) ⇒ LeyningNames

Transliterated English and Hebrew names of this parsha

Kind: global function

| Param | Type | Description | | --- | --- | --- | | parsha | string | Array.<string> | untranslated name like 'Pinchas' or ['Pinchas'] or ['Matot','Masei'] |

getWeekdayReading(parsha) ⇒ Object.<string, Aliyah>

Looks up Monday/Thursday aliyot for a regular parsha

Kind: global function
Returns: Object.<string, Aliyah> - map of aliyot

| Param | Type | Description | | --- | --- | --- | | parsha | string | Array.<string> | untranslated name like 'Pinchas' or ['Pinchas'] or ['Matot','Masei'] |

getLeyningForParsha(parsha) ⇒ Leyning

Looks up regular leyning for a weekly parsha with no special readings

Kind: global function
Returns: Leyning - map of aliyot

| Param | Type | Description | | --- | --- | --- | | parsha | string | Array.<string> | untranslated name like 'Pinchas' or ['Pinchas'] or ['Matot','Masei'] |

getLeyningForParshaHaShavua(ev, [il]) ⇒ Leyning

Looks up leyning for a regular Shabbat parsha, including any special maftir or Haftara.

Kind: global function
Returns: Leyning - map of aliyot

| Param | Type | Default | Description | | --- | --- | --- | --- | | ev | Event | | the Hebcal event associated with this leyning | | [il] | boolean | false | in Israel |

lookupParsha(parsha) ⇒ ParshaMeta

Returns the parsha metadata

Kind: global function

| Param | Type | Description | | --- | --- | --- | | parsha | string | Array.<string> | untranslated name like 'Pinchas' or ['Pinchas'] or ['Matot','Masei'] |

getLeyningOnDate(hdate, il, [wantarray]) ⇒ Leyning | Array.<Leyning>

Looks up leyning for a regular Shabbat, Monday/Thursday weekday or holiday.

If hdate coincides with a holiday that has Torah reading, returns the reading for that day (see getLeyningForHoliday)

Otherwise, if hdate is a Saturday, returns getLeyningForParshaHaShavua

Otherwise, if hdate is a Monday or Thursday, returns Leyning for the Parashat haShavua, containing only the weekday aliyot (no fullkriyah).

Otherwise, returns undefined.

Kind: global function
Returns: Leyning | Array.<Leyning> - map of aliyot

| Param | Type | Default | Description | | --- | --- | --- | --- | | hdate | HDate | | Hebrew Date | | il | boolean | | in Israel | | [wantarray] | boolean | false | to return an array of 0 or more readings |

writeCsvLines(stream, ev, reading, il, isParsha)

Formats reading for CSV

Kind: global function

| Param | Type | | --- | --- | | stream | fs.WriteStream | | ev | Event | | reading | Leyning | | il | boolean | | isParsha | boolean |