@hebcal/leyning
Version:
Torah Reading API for Parashat HaShavua and holidays
16 lines (15 loc) • 758 B
TypeScript
import { HDate } from '@hebcal/hdate';
import { AliyotMap, SpecialReading } from './types';
/**
* 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`.
*/
export declare function specialReadings2(parsha: string[], hd: HDate, il: boolean, aliyot: AliyotMap): SpecialReading;