@hebcal/leyning 4.17.0 → 4.18.2

package/leyning.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="node"/>
 
-import {Event} from '@hebcal/core';
+import {Event, HDate} from '@hebcal/core';
 import {WriteStream} from 'fs';
 
 declare module '@hebcal/leyning' {
@@ -28,6 +28,14 @@ declare module '@hebcal/leyning' {
      * Leyning for a parsha hashavua or holiday
      */
     export type Leyning = {
+        name: {
+            en: string;
+            he: string;
+        };
+        /** An array of either 1 (regular) or 2 (doubled parsha). `undefined` for holiday readings */
+        parsha?: string[];
+        /** 1 for Bereshit, 2 for Noach, etc. `undefined` for holiday readings */
+        parshaNum?: number;
         /** Such as `Genesis 1:1 - 6:8` */
         summary: string;
         /** Haftarah object */
@@ -52,6 +60,24 @@ declare module '@hebcal/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 {@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 Hebrew Date
+     * @param il in Israel
+     * @returns map of aliyot
+     */
+    export function getLeyningOnDate(hdate: HDate, il: boolean): Leyning;
+
     /**
      * Represents triennial aliyot for a given date
      */
@@ -77,20 +103,20 @@ declare module '@hebcal/leyning' {
 
     /**
      * Based on the event date, type and title, finds the relevant leyning key
-     * @param e - event
+     * @param ev - the Hebcal holiday event
      * @param [il] - true if Israel holiday scheme
      * @returns key to look up in holiday-reading.json
      */
-    export function getLeyningKeyForEvent(e: Event, il?: boolean): string;
+    export function getLeyningKeyForEvent(ev: Event, il?: boolean): string;
 
     /**
      * Looks up leyning for a given holiday. Returns some
      * of full kriyah aliyot, special Maftir, special Haftarah
-     * @param e - the Hebcal event associated with this leyning
+     * @param ev - the Hebcal event associated with this leyning
      * @param [il] - true if Israel holiday scheme
      * @returns map of aliyot
      */
-    export function getLeyningForHoliday(e: Event, il?: boolean): Leyning;
+    export function getLeyningForHoliday(ev: Event, il?: boolean): Leyning;
 
     /**
      * Looks up leyning for a given holiday key. Key should be an
@@ -102,12 +128,13 @@ declare module '@hebcal/leyning' {
     export function getLeyningForHolidayKey(key: string): Leyning;
 
     /**
-     * Looks up leyning for a regular Shabbat parsha.
-     * @param e - the Hebcal event associated with this 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 function getLeyningForParshaHaShavua(e: Event, il?: boolean): Leyning;
+    export function getLeyningForParshaHaShavua(ev: Event, il?: boolean): Leyning;
 
     /**
      * Looks up regular leyning for a weekly parsha with no special readings

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hebcal/leyning",
-  "version": "4.17.0",
+  "version": "4.18.2",
   "author": "Michael J. Radwin (https://github.com/mjradwin)",
   "keywords": [
     "hebcal",
@@ -31,7 +31,7 @@
     "leyning-csv": "bin/leyning-csv"
   },
   "dependencies": {
-    "@hebcal/core": "^3.42.1"
+    "@hebcal/core": "^3.42.2"
   },
   "scripts": {
     "build": "rollup -c",
@@ -61,11 +61,11 @@
     "@rollup/plugin-node-resolve": "^13.3.0",
     "ava": "^4.3.1",
     "core-js": "^3.24.1",
-    "eslint": "^8.21.0",
+    "eslint": "^8.22.0",
     "eslint-config-google": "^0.14.0",
     "jsdoc": "^3.6.11",
     "jsdoc-to-markdown": "^7.1.1",
-    "rollup": "^2.77.2",
+    "rollup": "^2.78.0",
     "rollup-plugin-terser": "^7.0.2"
   }
 }