@hebcal/core 5.4.0 → 5.4.1

package/README.md

@@ -28,7 +28,7 @@ $ npm install @hebcal/core
 ```javascript
 import {HebrewCalendar, HDate, Location, Event} from '@hebcal/core';
 
-const options = {
+const options: CalOptions = {
   year: 1981,
   isHebrewYear: false,
   candlelighting: true,
@@ -3105,7 +3105,7 @@ Additional locales (such as `ru` or `fr`) are supported by the
 **Example**  
 ```js
 import {HebrewCalendar, HDate, Location, Event} from '@hebcal/core';
-const options = {
+const options: CalOptions = {
   year: 1981,
   isHebrewYear: false,
   candlelighting: true,

package/dist/CalOptions.d.ts

@@ -0,0 +1,157 @@
+import { HDate } from '@hebcal/hdate';
+import { Location } from './location';
+/**
+ * Options to configure which events are returned
+ */
+export type CalOptions = {
+    /**
+     * latitude/longitude/tzid used for candle-lighting
+     */
+    location?: Location;
+    /**
+     * Gregorian or Hebrew year
+     */
+    year?: number;
+    /**
+     * to interpret year as Hebrew year
+     */
+    isHebrewYear?: boolean;
+    /**
+     * Gregorian or Hebrew month (to filter results to a single month)
+     */
+    month?: number | string;
+    /**
+     * generate calendar for multiple years (default 1)
+     */
+    numYears?: number;
+    /**
+     * use specific start date (requires end date)
+     */
+    start?: number | HDate | Date;
+    /**
+     * use specific end date (requires start date)
+     */
+    end?: number | HDate | Date;
+    /**
+     * calculate candle-lighting and havdalah times
+     */
+    candlelighting?: boolean;
+    /**
+     * minutes before sundown to light candles (default 18)
+     */
+    candleLightingMins?: number;
+    /**
+     * minutes after sundown for Havdalah (typical values are 42, 50, or 72).
+     * If `undefined` (the default), calculate Havdalah according to Tzeit Hakochavim -
+     * Nightfall (the point when 3 small stars are observable in the night time sky with
+     * the naked eye). If `0`, Havdalah times are suppressed.
+     */
+    havdalahMins?: number;
+    /**
+     * degrees for solar depression for Havdalah.
+     * Default is 8.5 degrees for 3 small stars. use 7.083 degrees for 3 medium-sized stars
+     * (observed by Dr. Baruch (Berthold) Cohn in his luach published in France in 1899).
+     * If `0`, Havdalah times are suppressed.
+     */
+    havdalahDeg?: number;
+    /**
+     * degrees for solar depression for end of fast days.
+     * Default is 7.083 degrees for 3 medium-sized stars. Other commonly-used values include
+     * 6.45 degrees, as calculated by Rabbi Yechiel Michel Tucazinsky.
+     */
+    fastEndDeg?: number;
+    /**
+     * use elevation for calculations (default `false`).
+     * If `true`, use elevation to affect the calculation of all sunrise/sunset based zmanim.
+     * Note: there are some zmanim such as degree-based zmanim that are driven by the amount
+     * of light in the sky and are not impacted by elevation.
+     * These zmanim intentionally do not support elevation adjustment.
+     */
+    useElevation?: boolean;
+    /**
+     * calculate parashah hashavua on Saturdays
+     */
+    sedrot?: boolean;
+    /**
+     * Israeli holiday and sedra schedule
+     */
+    il?: boolean;
+    /**
+     * suppress minor fasts
+     */
+    noMinorFast?: boolean;
+    /**
+     * suppress modern holidays
+     */
+    noModern?: boolean;
+    /**
+     * suppress Rosh Chodesh
+     */
+    noRoshChodesh?: boolean;
+    /**
+     * add Shabbat Mevarchim
+     */
+    shabbatMevarchim?: boolean;
+    /**
+     * suppress Special Shabbat
+     */
+    noSpecialShabbat?: boolean;
+    /**
+     * suppress regular holidays
+     */
+    noHolidays?: boolean;
+    /**
+     * include Days of the Omer
+     */
+    omer?: boolean;
+    /**
+     * include event announcing the molad
+     */
+    molad?: boolean;
+    /**
+     * use Ashkenazi transliterations for event titles (default Sephardi transliterations)
+     */
+    ashkenazi?: boolean;
+    /**
+     * translate event titles according to a locale
+     * Default value is `en`, also built-in are `he` and `ashkenazi`.
+     * Additional locales (such as `ru` or `fr`) are provided by the
+     * {@link https://github.com/hebcal/hebcal-locales @hebcal/locales} package
+     */
+    locale?: string;
+    /**
+     * print the Hebrew date for the entire date range
+     */
+    addHebrewDates?: boolean;
+    /**
+     * print the Hebrew date for dates with some events
+     */
+    addHebrewDatesForEvents?: boolean;
+    /**
+     * use bitmask from `flags` to filter events
+     */
+    mask?: number;
+    /**
+     * include Yom Kippur Katan (default `false`).
+     * יוֹם כִּפּוּר קָטָן is a minor day of atonement occurring monthly on the day preceeding each Rosh Chodesh.
+     * Yom Kippur Katan is omitted in Elul (on the day before Rosh Hashanah),
+     * Tishrei (Yom Kippur has just passed), Kislev (due to Chanukah)
+     * and Nisan (fasting not permitted during Nisan).
+     * When Rosh Chodesh occurs on Shabbat or Sunday, Yom Kippur Katan is observed on the preceding Thursday.
+     * See {@link https://en.wikipedia.org/wiki/Yom_Kippur_Katan#Practices Wikipedia Yom Kippur Katan practices}
+     */
+    yomKippurKatan?: boolean;
+    /**
+     * Whether to use 12-hour time (as opposed to 24-hour time).
+     * Possible values are `true` and `false`; the default is locale dependent.
+     */
+    hour12?: boolean;
+    /**
+     * map of options to enable daily study calendars
+     * such as `dafYomi`, `mishnaYomi`, `nachYomi` with value `true`. For `yerushalmi`
+     * the value should be a `number` for edition (`1` for Vilna, `2` for Schottenstein).
+     */
+    dailyLearning?: {
+        [x: string]: any;
+    };
+};

package/dist/DailyLearning.d.ts

@@ -1,9 +1,10 @@
+import { HDate } from '@hebcal/hdate';
 /**
  * Plug-ins for daily learning calendars such as Daf Yomi, Mishna Yomi, Nach Yomi, etc.
  *
  * Learning schedules are provided by the `@hebcal/learning` package.
  */
-export class DailyLearning {
+export declare class DailyLearning {
     /**
      * Register a new learning calendar.
      * @param {string} name

package/dist/HebrewDateEvent.d.ts

@@ -1,14 +1,39 @@
+import { HDate } from '@hebcal/hdate';
+import { Event } from './event';
 /** Daily Hebrew date ("11th of Sivan, 5780") */
-export class HebrewDateEvent extends Event {
+export declare class HebrewDateEvent extends Event {
     /**
      * @param {HDate} date
      */
     constructor(date: HDate);
+    /**
+     * @param {string} [locale] Optional locale name (defaults to active locale).
+     * @example
+     * import {HDate, HebrewDateEvent, months} from '@hebcal/core';
+     *
+     * const hd = new HDate(15, months.CHESHVAN, 5769);
+     * const ev = new HebrewDateEvent(hd);
+     * console.log(ev.render('en')); // '15th of Cheshvan, 5769'
+     * console.log(ev.render('he')); // 'ט״ו חֶשְׁוָן תשס״ט'
+     * @return {string}
+     */
+    render(locale?: string): string;
     /**
      * @private
      * @param {string} locale
      * @return {string}
      */
     private renderBriefHebrew;
+    /**
+     * @param {string} [locale] Optional locale name (defaults to active locale).
+     * @example
+     * import {HDate, HebrewDateEvent, months} from '@hebcal/core';
+     *
+     * const hd = new HDate(15, months.CHESHVAN, 5769);
+     * const ev = new HebrewDateEvent(hd);
+     * console.log(ev.renderBrief()); // '15th of Cheshvan'
+     * console.log(ev.renderBrief('he')); // 'ט״ו חֶשְׁוָן'
+     * @return {string}
+     */
+    renderBrief(locale?: string): string;
 }
-import { Event } from './event.js';

package/dist/HolidayEvent.d.ts

@@ -0,0 +1,45 @@
+import { Event } from './event';
+import { TimedEvent } from './TimedEvent';
+/** Represents a built-in holiday like Pesach, Purim or Tu BiShvat */
+export declare class HolidayEvent extends Event {
+    readonly cholHaMoedDay?: number;
+    startEvent?: TimedEvent | null;
+    endEvent?: TimedEvent | null;
+    /** @return {string} */
+    basename(): string;
+    /** @return {string | undefined} */
+    url(): string | undefined;
+    /** @return {string} */
+    urlDateSuffix(): string;
+    /** @return {string} */
+    getEmoji(): string;
+    /** @return {string[]} */
+    getCategories(): string[];
+    /**
+     * Returns (translated) description of this event
+     * @param {string} [locale] Optional locale name (defaults to active locale).
+     * @return {string}
+     */
+    render(locale?: string): string;
+    /**
+     * Returns a brief (translated) description of this event.
+     * For most events, this is the same as render(). For some events, it procudes
+     * a shorter text (e.g. without a time or added description).
+     * @param {string} [locale] Optional locale name (defaults to active locale).
+     * @return {string}
+     */
+    renderBrief(locale?: string): string;
+    /**
+     * Makes a clone of this Event object
+     * @return {Event}
+     */
+    clone(): HolidayEvent;
+}
+/**
+ * Because Asara B'Tevet often occurs twice in the same Gregorian year,
+ * we subclass HolidayEvent to override the `url()` method.
+ */
+export declare class AsaraBTevetEvent extends HolidayEvent {
+    /** @return {string} */
+    urlDateSuffix(): string;
+}

package/dist/MevarchimChodeshEvent.d.ts

@@ -0,0 +1,27 @@
+import { HDate } from '@hebcal/hdate';
+import { Event } from './event';
+/** Represents Mevarchim haChodesh, the announcement of the new month */
+export declare class MevarchimChodeshEvent extends Event {
+    readonly monthName: string;
+    /**
+     * Constructs Mevarchim haChodesh event
+     * @param {HDate} date Hebrew date event occurs
+     * @param {string} monthName Hebrew month name (not translated)
+     * @param {string} [memo]
+     */
+    constructor(date: HDate, monthName: string, memo: string);
+    /** @return {string} */
+    basename(): string;
+    /**
+     * Returns (translated) description of this event
+     * @param {string} [locale] Optional locale name (defaults to active locale).
+     * @return {string}
+     */
+    render(locale?: string): string;
+    /**
+     * Returns (translated) description of this event
+     * @param {string} [locale] Optional locale name (defaults to active locale).
+     * @return {string}
+     */
+    renderBrief(locale?: string): string;
+}

package/dist/ParshaEvent.d.ts

@@ -1,19 +1,29 @@
+import { Event } from './event';
+import { HDate } from '@hebcal/hdate';
 /**
  * Represents one of 54 weekly Torah portions, always on a Saturday
  */
-export class ParshaEvent extends Event {
+export declare class ParshaEvent extends Event {
+    private readonly parsha;
+    private readonly il;
+    private readonly num;
     /**
      * @param {HDate} date
      * @param {string[]} parsha - untranslated name of single or double parsha,
      *   such as ['Bereshit'] or ['Achrei Mot', 'Kedoshim']
-     * @param {boolean} il
-     * @param {number|number[]} num
+     * @param {boolean} [il]
+     * @param {number|number[]} [num]
      */
-    constructor(date: HDate, parsha: string[], il: boolean, num: number | number[]);
-    parsha: string[];
-    il: boolean;
-    num: number | number[];
+    constructor(date: HDate, parsha: string[], il?: boolean, num?: number | number[]);
+    /**
+     * @param {string} [locale] Optional locale name (i.e: `'he'`, `'fr'`). Defaults to active locale.
+     * @return {string}
+     */
+    render(locale?: string): string;
+    /** @return {string} */
+    basename(): string;
+    /** @return {string | undefined} */
+    url(): string | undefined;
     /** @return {string} */
     urlDateSuffix(): string;
 }
-import { Event } from './event.js';

package/dist/TimedEvent.d.ts

@@ -0,0 +1,53 @@
+import { HDate } from '@hebcal/hdate';
+import { CalOptions } from './CalOptions';
+import { Location } from './location';
+import { Event } from './event';
+/** An event that has an `eventTime` and `eventTimeStr` */
+export declare class TimedEvent extends Event {
+    readonly eventTime: Date;
+    readonly location: Location;
+    readonly eventTimeStr: string;
+    readonly fmtTime: string;
+    readonly linkedEvent?: Event;
+    /**
+     * @param {string} desc Description (not translated)
+     */
+    constructor(date: HDate, desc: string, mask: number, eventTime: Date, location: Location, linkedEvent?: Event, options?: CalOptions);
+    /**
+     * @param {string} [locale] Optional locale name (defaults to active locale).
+     * @return {string}
+     */
+    render(locale?: string): string;
+    /**
+     * Returns translation of "Candle lighting" without the time.
+     * @param {string} [locale] Optional locale name (defaults to active locale).
+     * @return {string}
+     */
+    renderBrief(locale?: string): string;
+    /** @return {string[]} */
+    getCategories(): string[];
+}
+/** Candle lighting before Shabbat or holiday */
+export declare class CandleLightingEvent extends TimedEvent {
+    constructor(date: HDate, mask: number, eventTime: Date, location: Location, linkedEvent?: Event, options?: CalOptions);
+    /** @return {string} */
+    getEmoji(): string;
+}
+/** Havdalah after Shabbat or holiday */
+export declare class HavdalahEvent extends TimedEvent {
+    private readonly havdalahMins?;
+    constructor(date: HDate, mask: number, eventTime: Date, location: Location, havdalahMins?: number, linkedEvent?: Event, options?: CalOptions);
+    /**
+     * @param {string} [locale] Optional locale name (defaults to active locale).
+     * @return {string}
+     */
+    render(locale?: string): string;
+    /**
+     * Returns translation of "Havdalah" without the time.
+     * @param {string} [locale] Optional locale name (defaults to active locale).
+     * @return {string}
+     */
+    renderBrief(locale?: string): string;
+    /** @return {string} */
+    getEmoji(): string;
+}

package/dist/YomKippurKatanEvent.d.ts

@@ -0,0 +1,27 @@
+import { HDate } from '@hebcal/hdate';
+import { HolidayEvent } from './HolidayEvent';
+export declare const ykk = "Yom Kippur Katan";
+/** YKK is minor day of atonement on the day preceeding each Rosh Chodesh */
+export declare class YomKippurKatanEvent extends HolidayEvent {
+    private readonly nextMonthName;
+    /**
+     * @private
+     * @param {HDate} date Hebrew date event occurs
+     * @param {string} nextMonthName name of the upcoming month
+     */
+    constructor(date: HDate, nextMonthName: string);
+    /** @return {string} */
+    basename(): string;
+    /**
+     * @param {string} [locale] Optional locale name (defaults to active locale).
+     * @return {string}
+     */
+    render(locale?: string): string;
+    /**
+     * @param {string} [locale] Optional locale name (defaults to active locale).
+     * @return {string}
+     */
+    renderBrief(locale?: string): string;
+    /** @return {string | undefined} */
+    url(): string | undefined;
+}