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

Torah Reading API for Parashat HaShavua and holidays

import { Event } from '@hebcal/core/dist/esm/event';
import { AliyotMap, Leyning, LeyningNames, ParshaMeta } from './types';
/**
 * Transliterated English and Hebrew names of this parsha
 * @param parsha untranslated name like ['Pinchas'] or ['Matot','Masei']
 */
export declare function makeLeyningNames(parsha: string[]): LeyningNames;
/**
 * Looks up Monday/Thursday aliyot for a regular parsha
 * @param parsha untranslated name like 'Pinchas' or ['Pinchas'] or ['Matot','Masei']
 */
export declare function getWeekdayReading(parsha: string | string[], language?: string): AliyotMap;
/**
 * Looks up regular leyning for a weekly parsha with no special readings
 * @param parsha untranslated name like 'Pinchas' or ['Pinchas'] or ['Matot','Masei']
 */
export declare function getLeyningForParsha(parsha: string | string[], language?: string): Leyning;
/**
 * Looks up leyning for a regular Shabbat parsha, including any special
 * maftir or Haftara.
 * @param ev the Hebcal event associated with this leyning
 * @param [il] in Israel
 * @returns map of aliyot
 */
export declare function getLeyningForParshaHaShavua(ev: Event, il?: boolean, language?: string): Leyning;
/**
 * Returns the parsha metadata
 * @param parsha untranslated name like 'Pinchas' or ['Pinchas'] or ['Matot','Masei']
 */
export declare function lookupParsha(parsha: string | string[], language?: string): ParshaMeta;