@hebcal/leyning/dist/esm/getLeyningOnDate.d.ts

Torah Reading API for Parashat HaShavua and holidays

import { HDate } from '@hebcal/hdate';
import { Leyning, LeyningWeekday } from './types';
/**
 * 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 {@link getLeyningForHoliday})
 *
 * Otherwise, if `hdate` is a Saturday, returns {@link getLeyningForParshaHaShavua}
 *
 * Otherwise, if `hdate` is a Monday or Thursday, returns {@link Leyning} for the
 * Parashat haShavua, containing only the `weekday` aliyot (no `fullkriyah`).
 *
 * Otherwise, returns `undefined`.
 *
 * @param {HDate} hdate Hebrew Date
 * @param {boolean} il in Israel
 * @param {boolean} [wantarray] to return an array of 0 or more readings
 * @param {string} [language] language for summary (default 'en')
 */
export declare function getLeyningOnDate(hdate: HDate, il: boolean, wantarray?: false, language?: string): Leyning | LeyningWeekday | undefined;
export declare function getLeyningOnDate(hdate: HDate, il: boolean, wantarray: true, language?: string): (Leyning | LeyningWeekday)[];