@hebcal/core 5.4.0 → 5.4.2

package/dist/locale.d.ts

@@ -1,80 +1 @@
-/**
- * A locale in Hebcal is used for translations/transliterations of
- * holidays. `@hebcal/core` supports four locales by default
- * * `en` - default, Sephardic transliterations (e.g. "Shabbat")
- * * `ashkenazi` - Ashkenazi transliterations (e.g. "Shabbos")
- * * `he` - Hebrew (e.g. "שַׁבָּת")
- * * `he-x-NoNikud` - Hebrew without nikud (e.g. "שבת")
- */
-export class Locale {
-    /**
-     * Returns translation only if `locale` offers a non-empty translation for `id`.
-     * Otherwise, returns `undefined`.
-     * @param {string} id Message ID to translate
-     * @param {string} [locale] Optional locale name (i.e: `'he'`, `'fr'`). Defaults to active locale.
-     * @return {string | undefined}
-     */
-    static lookupTranslation(id: string, locale?: string | undefined): string | undefined;
-    /**
-     * By default, if no translation was found, returns `id`.
-     * @param {string} id Message ID to translate
-     * @param {string} [locale] Optional locale name (i.e: `'he'`, `'fr'`). Defaults to active locale.
-     * @return {string}
-     */
-    static gettext(id: string, locale?: string | undefined): string;
-    /**
-     * Register locale translations.
-     * @param {string} locale Locale name (i.e.: `'he'`, `'fr'`)
-     * @param {LocaleData} data parsed data from a `.po` file.
-     */
-    static addLocale(locale: string, data: LocaleData): void;
-    /**
-     * Adds a translation to `locale`, replacing any previous translation.
-     * @param {string} locale Locale name (i.e: `'he'`, `'fr'`).
-     * @param {string} id Message ID to translate
-     * @param {string} translation Translation text
-     */
-    static addTranslation(locale: string, id: string, translation: string): void;
-    /**
-     * Adds multiple translations to `locale`, replacing any previous translations.
-     * @param {string} locale Locale name (i.e: `'he'`, `'fr'`).
-     * @param {LocaleData} data parsed data from a `.po` file.
-     */
-    static addTranslations(locale: string, data: LocaleData): void;
-    /**
-     * Activates a locale. Throws an error if the locale has not been previously added.
-     * After setting the locale to be used, all strings marked for translations
-     * will be represented by the corresponding translation in the specified locale.
-     * @param {string} locale Locale name (i.e: `'he'`, `'fr'`)
-     * @return {LocaleData}
-     */
-    static useLocale(locale: string): LocaleData;
-    /**
-     * Returns the name of the active locale (i.e. 'he', 'ashkenazi', 'fr')
-     * @return {string}
-     */
-    static getLocaleName(): string;
-    /**
-     * Returns the names of registered locales
-     * @return {string[]}
-     */
-    static getLocaleNames(): string[];
-    /**
-     * @param {number} n
-     * @param {string} [locale] Optional locale name (i.e: `'he'`, `'fr'`). Defaults to active locale.
-     * @return {string}
-     */
-    static ordinal(n: number, locale?: string | undefined): string;
-    /**
-     * @private
-     * @param {number} n
-     * @return {string}
-     */
-    private static getEnOrdinal;
-    /**
-     * Removes nekudot from Hebrew string
-     * @param {string} str
-     * @return {string}
-     */
-    static hebrewStripNikkud(str: string): string;
-}
+export {};

package/dist/location.d.ts

@@ -1,5 +1,41 @@
+import { GeoLocation } from '@hebcal/noaa';
 /** Class representing Location */
-export class Location extends GeoLocation {
+export declare class Location extends GeoLocation {
+    private readonly il;
+    private readonly cc?;
+    private readonly geoid?;
+    /**
+     * Initialize a Location instance
+     * @param {number} latitude - Latitude as a decimal, valid range -90 thru +90 (e.g. 41.85003)
+     * @param {number} longitude - Longitude as a decimal, valid range -180 thru +180 (e.g. -87.65005)
+     * @param {boolean} il - in Israel (true) or Diaspora (false)
+     * @param {string} tzid - Olson timezone ID, e.g. "America/Chicago"
+     * @param {string} [cityName] - optional descriptive city name
+     * @param {string} [countryCode] - ISO 3166 alpha-2 country code (e.g. "FR")
+     * @param {string|number} [geoid] - optional string or numeric geographic ID
+     * @param {number} [elevation] - in meters (default `0`)
+     */
+    constructor(latitude: number, longitude: number, il: boolean, tzid: string, cityName?: string, countryCode?: string, geoid?: string | number, elevation?: number);
+    /** @return {boolean} */
+    getIsrael(): boolean;
+    /** @return {string | null} */
+    getName(): string | null;
+    /**
+     * Returns the location name, up to the first comma
+     * @return {string | null}
+     */
+    getShortName(): string | null;
+    /** @return {string | undefined} */
+    getCountryCode(): string | undefined;
+    /** @return {string} */
+    getTzid(): string;
+    /**
+     * Gets a 24-hour time formatter (e.g. 07:41 or 20:03) for this location
+     * @return {Intl.DateTimeFormat}
+     */
+    getTimeFormatter(): Intl.DateTimeFormat;
+    /** @return {string | number | undefined} */
+    getGeoId(): string | number | undefined;
     /**
      * Creates a location object from one of 60 "classic" Hebcal city names.
      * The following city names are supported:
@@ -17,16 +53,18 @@ export class Location extends GeoLocation {
      * 'Tel Aviv', 'Tiberias', 'Toronto', 'Vancouver', 'White Plains',
      * 'Washington DC', 'Worcester'
      * @param {string} name
-     * @return {Location}
+     * @return {Location|undefined}
      */
-    static lookup(name: string): Location;
+    static lookup(name: string): Location | undefined;
+    /** @return {string} */
+    toString(): string;
     /**
      * Converts legacy Hebcal timezone to a standard Olson tzid.
      * @param {number} tz integer, GMT offset in hours
      * @param {string} dst 'none', 'eu', 'usa', or 'israel'
-     * @return {string}
+     * @return {string | undefined}
      */
-    static legacyTzToTzid(tz: number, dst: string): string;
+    static legacyTzToTzid(tz: number, dst: string): string | undefined;
     /**
      * Converts timezone info from Zip-Codes.com to a standard Olson tzid.
      * @example
@@ -46,40 +84,4 @@ export class Location extends GeoLocation {
      * @return {boolean}
      */
     static addLocation(cityName: string, location: Location): boolean;
-    /**
-     * Initialize a Location instance
-     * @param {number} latitude - Latitude as a decimal, valid range -90 thru +90 (e.g. 41.85003)
-     * @param {number} longitude - Longitude as a decimal, valid range -180 thru +180 (e.g. -87.65005)
-     * @param {boolean} il - in Israel (true) or Diaspora (false)
-     * @param {string} tzid - Olson timezone ID, e.g. "America/Chicago"
-     * @param {string} cityName - optional descriptive city name
-     * @param {string} countryCode - ISO 3166 alpha-2 country code (e.g. "FR")
-     * @param {string} [geoid] - optional string or numeric geographic ID
-     * @param {number} [elevation] - in meters (default `0`)
-     */
-    constructor(latitude: number, longitude: number, il: boolean, tzid: string, cityName: string, countryCode: string, geoid?: string | undefined, elevation?: number | undefined);
-    il: boolean;
-    cc: string;
-    geoid: string | undefined;
-    /** @return {boolean} */
-    getIsrael(): boolean;
-    /** @return {string} */
-    getName(): string;
-    /**
-     * Returns the location name, up to the first comma
-     * @return {string}
-     */
-    getShortName(): string;
-    /** @return {string} */
-    getCountryCode(): string;
-    /** @return {string} */
-    getTzid(): string;
-    /**
-     * Gets a 24-hour time formatter (e.g. 07:41 or 20:03) for this location
-     * @return {Intl.DateTimeFormat}
-     */
-    getTimeFormatter(): Intl.DateTimeFormat;
-    /** @return {string} */
-    getGeoId(): string;
 }
-import { GeoLocation } from '@hebcal/noaa';

package/dist/modern.d.ts

@@ -1,3 +1,4 @@
+import { HDate } from '@hebcal/hdate';
 /**
  * Yom HaShoah first observed in 1951.
  * When the actual date of Yom Hashoah falls on a Friday, the
@@ -9,12 +10,11 @@
  * @param {number} year
  * @return {HDate|null}
  */
-export function dateYomHaShoah(year: number): HDate | null;
+export declare function dateYomHaShoah(year: number): HDate | null;
 /**
  * Yom HaAtzma'ut only celebrated after 1948
  * @private
  * @param {number} year
  * @return {HDate|null}
  */
-export function dateYomHaZikaron(year: number): HDate | null;
-import { HDate } from '@hebcal/hdate';
+export declare function dateYomHaZikaron(year: number): HDate | null;

package/dist/molad.d.ts

@@ -1,19 +1,18 @@
+import { Event } from './event';
+import { CalOptions } from './CalOptions';
+import { HDate } from '@hebcal/hdate';
+import '../src/locale';
 /**
  * Represents a molad, the moment when the new moon is "born"
  */
-export class Molad {
+export declare class Molad {
+    private readonly m;
     /**
      * Calculates the molad for a Hebrew month
      * @param {number} year
      * @param {number} month
      */
     constructor(year: number, month: number);
-    year: number;
-    month: number;
-    dow: number;
-    hour: number;
-    minutes: number;
-    chalakim: number;
     /**
      * @return {number}
      */
@@ -47,10 +46,12 @@ export class Molad {
      * @param {CalOptions} options
      * @return {string}
      */
-    render(locale?: string | undefined, options: CalOptions): string;
+    render(locale?: string, options?: CalOptions): string;
 }
 /** Represents a Molad announcement on Shabbat Mevarchim */
-export class MoladEvent extends Event {
+export declare class MoladEvent extends Event {
+    readonly molad: Molad;
+    private readonly options;
     /**
      * @param {HDate} date Hebrew date event occurs
      * @param {number} hyear molad year
@@ -58,8 +59,9 @@ export class MoladEvent extends Event {
      * @param {CalOptions} options
      */
     constructor(date: HDate, hyear: number, hmonth: number, options: CalOptions);
-    molad: Molad;
-    options: CalOptions;
+    /**
+     * @param {string} [locale] Optional locale name (defaults to active locale).
+     * @return {string}
+     */
+    render(locale?: string): string;
 }
-import { Event } from './event.js';
-import { HDate } from '@hebcal/hdate';

package/dist/omer.d.ts

@@ -1,18 +1,36 @@
+import { HDate } from '@hebcal/hdate';
+import { Event } from './event';
+import '../src/locale';
 /** Represents a day 1-49 of counting the Omer from Pesach to Shavuot */
-export class OmerEvent extends Event {
+export declare class OmerEvent extends Event {
+    private readonly weekNumber;
+    private readonly daysWithinWeeks;
+    readonly omer: number;
+    emoji?: string;
     /**
      * @param {HDate} date
      * @param {number} omerDay
      */
     constructor(date: HDate, omerDay: number);
-    weekNumber: number;
-    daysWithinWeeks: number;
-    omer: number;
     /**
      * @param {string} lang
      * @return {string}
      */
     sefira(lang?: string): string;
+    /**
+     * @todo use gettext()
+     * @param {string} [locale] Optional locale name (defaults to active locale).
+     * @return {string}
+     */
+    render(locale?: string): string;
+    /**
+     * Returns translation of "Omer day 22" without ordinal numbers.
+     * @param {string} [locale] Optional locale name (defaults to active locale).
+     * @return {string}
+     */
+    renderBrief(locale?: string): string;
+    /** @return {string} */
+    getEmoji(): string;
     /** @return {number} */
     getWeeks(): number;
     /** @return {number} */
@@ -22,5 +40,6 @@ export class OmerEvent extends Event {
      * @return {string}
      */
     getTodayIs(locale: string): string;
+    /** @return {string} */
+    url(): string;
 }
-import { Event } from './event.js';

package/dist/pkgVersion.d.ts

@@ -1 +1,2 @@
-export const version: "5.4.0";
+/** DO NOT EDIT THIS AUTO-GENERATED FILE! */
+export declare const version = "5.4.2";

package/dist/reformatTimeStr.d.ts

@@ -1,3 +1,4 @@
+import { CalOptions } from './CalOptions';
 /**
  * @private
  * @param {string} timeStr - original time like "20:30"
@@ -5,4 +6,4 @@
  * @param {CalOptions} options
  * @return {string}
  */
-export function reformatTimeStr(timeStr: string, suffix: string, options: CalOptions): string;
+export declare function reformatTimeStr(timeStr: string, suffix: string, options?: CalOptions): string;

package/dist/sedra.d.ts

@@ -1,8 +1,100 @@
+import { HDate } from '@hebcal/hdate';
+import '../src/locale';
+/** The result from `Sedra.lookup()` */
+export type SedraResult = {
+    /**
+     * Name of the parsha (or parshiyot) read on
+     * Hebrew date, e.g. `['Noach']` or `['Matot', 'Masei']`
+     */
+    parsha: string[];
+    /**
+     * True if this is a regular parasha HaShavua
+     * Torah reading, false if it's a special holiday reading
+     */
+    chag: boolean;
+    /**
+     * The parsha number (or numbers) using 1-indexing.
+     * A `number` for a regular (single) parsha, and a `number[]`
+     * for a doubled parsha.
+     * For Parashat *Bereshit*, `num` would be equal to `1`, and for
+     * *Matot-Masei* it would be `[42, 43]`
+     */
+    num?: number | number[];
+};
+/**
+ * Represents Parashah HaShavua for an entire Hebrew year
+ */
+export declare class Sedra {
+    private readonly year;
+    private readonly il;
+    private readonly firstSaturday;
+    private readonly theSedraArray;
+    /**
+     * Caculates the Parashah HaShavua for an entire Hebrew year
+     * @param {number} hyear - Hebrew year (e.g. 5749)
+     * @param {boolean} il - Use Israel sedra schedule (false for Diaspora)
+     */
+    constructor(hyear: number, il: boolean);
+    /**
+     * Returns the parsha (or parshiyot) read on Hebrew date
+     * @param {HDate|number} hd Hebrew date or R.D. days
+     * @return {string[]}
+     */
+    get(hd: HDate | number): string[];
+    /**
+     * Looks up parsha for the date, then returns a translated or transliterated string
+     * @param {HDate|number} hd Hebrew date or R.D. days
+     * @param {string} [locale] Optional locale name (i.e: `'he'`, `'fr'`). Defaults to active locale
+     * @return {string}
+     */
+    getString(hd: HDate | number, locale?: string): string;
+    /**
+     * Checks to see if this day would be a regular parasha HaShavua
+     * Torah reading or special holiday reading
+     * @param {HDate|number} hd Hebrew date or R.D. days
+     * @return {boolean}
+     */
+    isParsha(hd: HDate | number): boolean;
+    /**
+     * Returns the date that a parsha occurs
+     * or `null` if the parsha doesn't occur this year
+     * @param {number|string|string[]} parsha
+     * @return {HDate|null}
+     */
+    find(parsha: number | string | string[]): HDate | null;
+    /**
+     * Returns the underlying annual sedra schedule.
+     * Used by `@hebcal/triennial`
+     * @return {NumberOrString[]}
+     */
+    getSedraArray(): NumberOrString[];
+    /**
+     * R.D. date of the first Saturday on or after Rosh Hashana
+     * @return {number}
+     */
+    getFirstSaturday(): number;
+    /** @return {number} */
+    getYear(): number;
+    /**
+     * Returns an object describing the parsha on the first Saturday on or after `hd`
+     * @param {HDate|number} hd Hebrew date or R.D. days
+     * @return {SedraResult}
+     */
+    lookup(hd: HDate | number): SedraResult;
+}
+/**
+ * The 54 parshiyot of the Torah as transilterated strings
+ * parshiot[0] == 'Bereshit', parshiot[1] == 'Noach', parshiot[52] == "Ha'azinu".
+ * @readonly
+ * @type {string[]}
+ */
+export declare const parshiot: string[];
+type NumberOrString = number | string;
 /**
  * @private
  * @param {number} hyear
  * @param {boolean} il
  * @return {Sedra}
  */
-export function getSedra_(hyear: number, il: boolean): Sedra;
-import { Sedra } from '@hebcal/hdate';
+export declare function getSedra_(hyear: number, il: boolean): Sedra;
+export {};