@hebcal/core 6.0.8 → 6.2.0

package/dist/holidays.d.ts

@@ -1,22 +0,0 @@
-import { HDate } from '@hebcal/hdate';
-import { HolidayEvent } from './HolidayEvent';
-/**
- * Returns an array of Events on this date (or `undefined` if no events)
- * @param date Hebrew Date, Gregorian date, or absolute R.D. day number
- * @param [il] use the Israeli schedule for holidays
- */
-export declare function getHolidaysOnDate(date: HDate | Date | number, il?: boolean): HolidayEvent[] | undefined;
-export type HolidayYearMap = Map<string, HolidayEvent[]>;
-/**
- * Lower-level holidays interface, which returns a `Map` of `Event`s indexed by
- * `HDate.toString()`. These events must filtered especially for `flags.IL_ONLY`
- * or `flags.CHUL_ONLY` depending on Israel vs. Diaspora holiday scheme.
- * @private
- */
-export declare function getHolidaysForYear_(year: number): HolidayYearMap;
-/**
- * Returns an array of holidays for the year
- * @param year Hebrew year
- * @param il use the Israeli schedule for holidays
- */
-export declare function getHolidaysForYearArray(year: number, il: boolean): HolidayEvent[];

package/dist/index.d.ts

@@ -1,26 +0,0 @@
-export { version } from './pkgVersion';
-export { gematriya, gematriyaStrToNum } from '@hebcal/hdate';
-export { greg, months, HDate, Locale, Headers, StringArrayMap, LocaleData, MonthName, } from '@hebcal/hdate';
-import './locale';
-export { CalOptions, DailyLearningValue } from './CalOptions';
-export { HebrewDateEvent } from './HebrewDateEvent';
-export { Event, flags } from './event';
-export { GeoLocation, NOAACalculator } from '@hebcal/noaa';
-export { Location } from './location';
-export { Zmanim } from './zmanim';
-export { isAssurBemlacha } from './isAssurBemlacha';
-export { TimedEvent, CandleLightingEvent, HavdalahEvent } from './TimedEvent';
-export { FastDayEvent, TimedChanukahEvent } from './candles';
-export { Molad, MoladEvent } from './molad';
-export { OmerEvent, OmerLang } from './omer';
-export { TachanunResult } from './tachanun';
-export { Sedra, SedraResult, parshiot, getSedra } from './sedra';
-export { ParshaEvent } from './ParshaEvent';
-export { parshaYear } from './parshaYear';
-export { HolidayEvent, ChanukahEvent, AsaraBTevetEvent, RoshChodeshEvent, RoshHashanaEvent, } from './HolidayEvent';
-export { HolidayYearMap, getHolidaysOnDate } from './holidays';
-export { MevarchimChodeshEvent } from './MevarchimChodeshEvent';
-export { YomKippurKatanEvent } from './YomKippurKatanEvent';
-export { holidayDesc } from './staticHolidays';
-export { DailyLearning } from './DailyLearning';
-export { HebrewCalendar } from './hebcal';

package/dist/isAssurBemlacha.d.ts

@@ -1,9 +0,0 @@
-import { Location } from './location';
-/**
- * Utility method to determine if the date and time has a <em>melacha</em> (work) prohibition.
- * Although there are many opinions on the time of <em>tzais</em>, for simplicity
- * this function uses solar depression of 8.5 degrees.
- *
- * @return `true` if <em>melacha</em> is prohibited or `false` if it is not.
- */
-export declare function isAssurBemlacha(currentTime: Date, location: Location, useElevation: boolean): boolean;

package/dist/locale.d.ts

@@ -1,2 +0,0 @@
-import { Locale } from '@hebcal/hdate';
-export { Locale };

package/dist/location.d.ts

@@ -1,73 +0,0 @@
-import { GeoLocation } from '@hebcal/noaa';
-/** Class representing Location */
-export declare class Location extends GeoLocation {
-    private readonly il;
-    private readonly cc?;
-    private readonly geoid?;
-    /**
-     * Initialize a Location instance
-     * @param latitude - Latitude as a decimal, valid range -90 thru +90 (e.g. 41.85003)
-     * @param longitude - Longitude as a decimal, valid range -180 thru +180 (e.g. -87.65005)
-     * @param il - in Israel (true) or Diaspora (false)
-     * @param tzid - Olson timezone ID, e.g. "America/Chicago"
-     * @param [cityName] - optional descriptive city name
-     * @param [countryCode] - ISO 3166 alpha-2 country code (e.g. "FR")
-     * @param [geoid] - optional string or numeric geographic ID
-     * @param [elevation] - in meters (default `0`)
-     */
-    constructor(latitude: number, longitude: number, il: boolean, tzid: string, cityName?: string, countryCode?: string, geoid?: string | number, elevation?: number);
-    getIsrael(): boolean;
-    getName(): string | null;
-    /**
-     * Returns the location name, up to the first comma
-     */
-    getShortName(): string | null;
-    getCountryCode(): string | undefined;
-    getTzid(): string;
-    /**
-     * Gets a 24-hour time formatter (e.g. 07:41 or 20:03) for this location
-     */
-    getTimeFormatter(): Intl.DateTimeFormat;
-    getGeoId(): string | number | undefined;
-    /**
-     * Creates a location object from one of 60 "classic" Hebcal city names.
-     * The following city names are supported:
-     * 'Ashdod', 'Atlanta', 'Austin', 'Baghdad', 'Beer Sheva',
-     * 'Berlin', 'Baltimore', 'Bogota', 'Boston', 'Budapest',
-     * 'Buenos Aires', 'Buffalo', 'Chicago', 'Cincinnati', 'Cleveland',
-     * 'Dallas', 'Denver', 'Detroit', 'Eilat', 'Gibraltar', 'Haifa',
-     * 'Hawaii', 'Helsinki', 'Houston', 'Jerusalem', 'Johannesburg',
-     * 'Kiev', 'La Paz', 'Livingston', 'Las Vegas', 'London', 'Los Angeles',
-     * 'Marseilles', 'Miami', 'Minneapolis', 'Melbourne', 'Mexico City',
-     * 'Montreal', 'Moscow', 'New York', 'Omaha', 'Ottawa', 'Panama City',
-     * 'Paris', 'Pawtucket', 'Petach Tikvah', 'Philadelphia', 'Phoenix',
-     * 'Pittsburgh', 'Providence', 'Portland', 'Saint Louis', 'Saint Petersburg',
-     * 'San Diego', 'San Francisco', 'Sao Paulo', 'Seattle', 'Sydney',
-     * 'Tel Aviv', 'Tiberias', 'Toronto', 'Vancouver', 'White Plains',
-     * 'Washington DC', 'Worcester'
-     * @param name
-     */
-    static lookup(name: string): Location | undefined;
-    toString(): string;
-    /**
-     * Converts legacy Hebcal timezone to a standard Olson tzid.
-     * @param tz integer, GMT offset in hours
-     * @param dst 'none', 'eu', 'usa', or 'israel'
-     */
-    static legacyTzToTzid(tz: number, dst: string): string | undefined;
-    /**
-     * Converts timezone info from Zip-Codes.com to a standard Olson tzid.
-     * @example
-     * Location.getUsaTzid('AZ', 7, 'Y') // 'America/Denver'
-     * @param state two-letter all-caps US state abbreviation like 'CA'
-     * @param tz positive number, 5=America/New_York, 8=America/Los_Angeles
-     * @param dst single char 'Y' or 'N'
-     */
-    static getUsaTzid(state: string, tz: number, dst: string): string;
-    /**
-     * Adds a location name for `Location.lookup()` only if the name isn't
-     * already being used. Returns `false` if the name is already taken
-     * and `true` if successfully added.
-     */
-    static addLocation(cityName: string, location: Location): boolean;
-}

package/dist/modern.d.ts

@@ -1,18 +0,0 @@
-import { HDate } from '@hebcal/hdate';
-/**
- * Yom HaShoah first observed in 1951.
- * When the actual date of Yom Hashoah falls on a Friday, the
- * state of Israel observes Yom Hashoah on the preceding
- * Thursday. When it falls on a Sunday, Yom Hashoah is observed
- * on the following Monday.
- * http://www.ushmm.org/remembrance/dor/calendar/
- * @private
- * @param year
- */
-export declare function dateYomHaShoah(year: number): HDate | null;
-/**
- * Yom HaAtzma'ut only celebrated after 1948
- * @private
- * @param year
- */
-export declare function dateYomHaZikaron(year: number): HDate | null;

package/dist/molad.d.ts

@@ -1,62 +0,0 @@
-import { Event } from './event';
-import { CalOptions } from './CalOptions';
-import { HDate } from '@hebcal/hdate';
-import './locale';
-/**
- * Represents a molad, the moment when the new moon is "born"
- */
-export declare class Molad {
-    private readonly m;
-    /**
-     * Calculates the molad for a Hebrew month
-     * @param year
-     * @param month
-     */
-    constructor(year: number, month: number);
-    /**
-     */
-    getYear(): number;
-    /**
-     */
-    getMonth(): number;
-    /**
-     */
-    getMonthName(): string;
-    /**
-     * @returns Day of Week (0=Sunday, 6=Saturday)
-     */
-    getDow(): number;
-    /**
-     * @returns hour of day (0-23)
-     */
-    getHour(): number;
-    /**
-     * @returns minutes past hour (0-59)
-     */
-    getMinutes(): number;
-    /**
-     * @returns parts of a minute (0-17)
-     */
-    getChalakim(): number;
-    /**
-     * @param [locale] Optional locale name (defaults to empty locale)
-     * @param options
-     */
-    render(locale?: string, options?: CalOptions): string;
-}
-/** Represents a Molad announcement on Shabbat Mevarchim */
-export declare class MoladEvent extends Event {
-    readonly molad: Molad;
-    private readonly options;
-    /**
-     * @param date Hebrew date event occurs
-     * @param hyear molad year
-     * @param hmonth molad month
-     * @param options
-     */
-    constructor(date: HDate, hyear: number, hmonth: number, options: CalOptions);
-    /**
-     * @param [locale] Optional locale name (defaults to empty locale)
-     */
-    render(locale?: string): string;
-}

package/dist/omer.d.ts

@@ -1,53 +0,0 @@
-import { HDate } from '@hebcal/hdate';
-import { Event } from './event';
-import './locale';
-/**
- * Language for counting the Omer can be English or Hebrew.
- * Lang for the Sefira can be English, Hebrew, or Hebrew in Sephardic transliteration.
- */
-export type OmerLang = 'en' | 'he' | 'translit';
-/** Represents a day 1-49 of counting the Omer from Pesach to Shavuot */
-export declare class OmerEvent extends Event {
-    private readonly weekNumber;
-    private readonly daysWithinWeeks;
-    readonly omer: number;
-    emoji?: string;
-    /**
-     * @param date
-     * @param omerDay
-     */
-    constructor(date: HDate, omerDay: number);
-    /**
-     * Returns the sefira. For example, on day 8:
-     *  * חֶֽסֶד שֶׁבִּגְבוּרָה
-     *  * Chesed shebiGevurah
-     *  * Lovingkindness within Might
-     * @param lang `en` (English), `he` (Hebrew with nikud), or `translit` (Hebrew in Sephardic transliteration)
-     * @returns a string such as `Lovingkindness within Might` or `חֶֽסֶד שֶׁבִּגְבוּרָה`
-     */
-    sefira(lang?: OmerLang): string;
-    /**
-     * @param [locale] Optional locale name (defaults to empty locale)
-     */
-    render(locale?: string): string;
-    /**
-     * Returns translation of "Omer day 22" without ordinal numbers.
-     * @param [locale] Optional locale name (defaults to empty locale)
-     */
-    renderBrief(locale?: string): string;
-    /**
-     * Returns an emoji number symbol with a circle, for example `㊲`
-     *  from the “Enclosed CJK Letters and Months” block of the Unicode standard
-     * @returns a single Unicode character from `①` through `㊾`
-     */
-    getEmoji(): string;
-    getWeeks(): number;
-    getDaysWithinWeeks(): number;
-    /**
-     * Returns a sentence with that evening's omer count
-     * @returns a string such as `Today is 10 days, which is 1 week and 3 days of the Omer`
-     *  or `הַיוֹם עֲשָׂרָה יָמִים, שְׁהֵם שָׁבוּעַ אֶחָד וְשְׁלוֹשָׁה יָמִים לָעוֹמֶר`
-     */
-    getTodayIs(locale: string): string;
-    url(): string | undefined;
-}

package/dist/parshaName.d.ts

@@ -1,2 +0,0 @@
-/** @private */
-export declare function renderParshaName(parsha: string[], locale?: string): string;

package/dist/parshaYear.d.ts

@@ -1,9 +0,0 @@
-import { ParshaEvent } from './ParshaEvent';
-/**
- * Calculates weekly Torah Reading on Saturdays for entire year
- * @param year Hebrew year
- * @param il Israel (false for Diaspora)
- * @returns an array of `ParshaEvent` occurring on Saturdays that contain a regular
- *  (non-holiday) Parashat HaShavua
- */
-export declare function parshaYear(year: number, il: boolean): ParshaEvent[];

package/dist/pkgVersion.d.ts

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

package/dist/reformatTimeStr.d.ts

@@ -1,8 +0,0 @@
-import { CalOptions } from './CalOptions';
-/**
- * @private
- * @param timeStr - original time like "20:30"
- * @param suffix - "p" or "pm" or " P.M.". Add leading space if you want it
- * @param options
- */
-export declare function reformatTimeStr(timeStr: string, suffix: string, options?: CalOptions): string;

package/dist/sedra.d.ts

@@ -1,95 +0,0 @@
-import { HDate } from '@hebcal/hdate';
-import './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[];
-    /**
-     * False if this is a regular parashat HaShavua reading.
-     * True 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]`
-     * For a chag (holiday) reading, `num` will be `0`.
-     */
-    num: number | number[];
-    /** The date of the Shabbat this parsha is read */
-    hdate: HDate;
-    /** true if Israel, false for Diaspora */
-    il: boolean;
-};
-/**
- * Represents Parashah HaShavua for an entire Hebrew year
- */
-export declare class Sedra {
-    private readonly year;
-    private readonly il;
-    private readonly rh;
-    private readonly firstSaturday;
-    private readonly theSedraArray;
-    private readonly yearKey;
-    /**
-     * Caculates the Parashah HaShavua for an entire Hebrew year
-     * @param hyear - Hebrew year (e.g. 5749)
-     * @param il - Use Israel sedra schedule (false for Diaspora)
-     */
-    constructor(hyear: number, il: boolean);
-    /**
-     * Returns the date that a parsha occurs
-     * or `null` if the parsha doesn't occur this year
-     * @param parsha if a `string`, specified with Sephardic transliterations
-     *  like `'Noach'` or `'Matot-Masei'`. If an array, must be a 1- or 2-element
-     *  array such as `['Noach']` or `['Matot', 'Masei']`. If a `number`, should
-     *  be a 0-based parsha index (`0` for Bereshit, `1` for Noach) or a negative
-     *  number for a doubled parsha (e.g. `-21` for Vayakhel-Pekudei)
-     */
-    find(parsha: number | string | string[]): HDate | null;
-    private findInternal;
-    /**
-     * Returns the date that a parsha (or its doubled or undoubled counterpart)
-     * occurs, or `null` if the parsha doesn't occur this year
-     */
-    findContaining(parsha: number | string): HDate | null;
-    /**
-     * Returns the underlying annual sedra schedule.
-     * Used by `@hebcal/triennial`
-     */
-    getSedraArray(): readonly NumberOrString[];
-    /**
-     * R.D. date of the first Saturday on or after Rosh Hashana
-     */
-    getFirstSaturday(): number;
-    getYear(): number;
-    /**
-     * Returns an object describing the parsha on the first Saturday on or after `hd`
-     * @param hd Hebrew date or R.D. days
-     */
-    lookup(hd: HDate | number): SedraResult;
-}
-/**
- * The 54 parshiyot of the Torah as transilterated strings.
- * * parshiot[0] == `Bereshit`
- * * parshiot[1] == `Noach`
- * * parshiot[52] == `Ha'azinu`
- * * parshiot[53] == `Vezot Haberakhah`
- * @readonly
- * @type {string[]}
- */
-export declare const parshiot: readonly string[];
-type NumberOrString = number | string;
-/**
- * Convenience function to create an instance of `Sedra` or reuse a previously
- * created and cached instance.
- * @param hyear
- * @param il
- */
-export declare function getSedra(hyear: number, il: boolean): Sedra;
-export {};