hebcal-es6

Hebcal, a perpetual Jewish Calendar (ES6)

Installation

$ npm install @hebcal/core

Synopsis

import {hebcal, HDate, cities, Location, Event} from '@hebcal/core';

cities.init();

const options = {
  year: 1981,
  isHebrewYear: false,
  candlelighting: true,
  location: Location.newFromCity(cities.getCity('San Francisco')),
  sedrot: true,
  omer: true,
};
const events = hebcal.hebrewCalendar(options);

for (const ev of events) {
  const hd = ev.getDate();
  const date = hd.greg();
  console.log(date.toLocaleDateString(), ev.render(), hd.toString());
}

Classes

HDate: Class representing a Hebrew date
Event: Represents an Event with a title, date, and flags
OmerEvent: Represents a day 1-49 of counting the Omer from Pesach to Shavuot
DafYomiEvent: For a Daf Yomi, the name is already translated attrs.dafyomi.name contains the untranslated string
HavdalahEvent: Havdalah after Shabbat or holiday
CandleLightingEvent: Candle lighting before Shabbat or holiday
Location: Class representing Location
Sedra: Represents Parashah HaShavua for an entire Hebrew year

Constants

cities: Interface to lookup cities

Functions

hebLeapYear(x) ⇒ boolean: Returns true if Hebrew year is a leap year
monthsInHebYear(x) ⇒ number: Number of months in Hebrew year
daysInHebMonth(month, year) ⇒ number: Number of days in Hebrew month in a given year
getMonthName(month, year) ⇒ string: Returns an (untranslated) string name of Hebrew month in year
monthNum(month) ⇒ number: Returns the Hebrew month number
hebElapsedDays(hYear) ⇒ number: Days from sunday prior to start of Hebrew calendar to mean conjunction of Tishrei in Hebrew YEAR
daysInYear(year) ⇒ number: Number of days in the hebrew YEAR
longCheshvan(year) ⇒ boolean: true if Cheshvan is long in Hebrew YEAR
shortKislev(year) ⇒ boolean: true if Kislev is short in Hebrew YEAR
monthFromName(c) ⇒ number: Converts Hebrew month string name to numeric
dayOnOrBefore(day_of_week, absdate) ⇒ number: Note: Applying this function to d+6 gives us the DAYNAME on or after an absolute day d. Similarly, applying it to d+3 gives the DAYNAME nearest to absolute date d, applying it to d-1 gives the DAYNAME previous to absolute date d, and applying it to d+7 gives the DAYNAME following absolute date d.
range(start, end, [step]) ⇒ Array.<number>: Returns an array from start to end
gregLeapYear(year) ⇒ boolean: Returns true if the Gregorian year is a leap year
daysInGregMonth(month, year) ⇒ number: Number of days in the Gregorian month for given year
dayOfYear(date) ⇒ number: Returns number of days since January 1 of that year
greg2abs(date) ⇒ number: Converts Gregorian date to Julian Day Count
abs2greg(theDate) ⇒ Date: Converts from Julian Day Count to Gregorian date. See the footnote on page 384 of ``Calendrical Calculations, Part II: Three Historical Calendars'' by E. M. Reingold, N. Dershowitz, and S. M. Clamen, Software--Practice and Experience, Volume 23, Number 4 (April, 1993), pages 383-404 for an explanation.
onOrBefore(day, t, offset) ⇒ HDate
hebrew2abs(d) ⇒ number: Converts Hebrew date to absolute Julian days. The absolute date is the number of days elapsed since the (imaginary) Gregorian date Sunday, December 31, 1 BC.
abs2hebrew(d) ⇒ SimpleHebrewDate: Converts Julian days to Hebrew date to absolute Julian days
getMolad(year, month) ⇒ Molad: Calculates the molad for a Hebrew month
getBirthdayOrAnniversary(hyear, gdate) ⇒ HDate: Calculates a birthday or anniversary (non-yahrzeit). Year must be after original date of anniversary. Returns undefined when requested year preceeds or is same as original year.
getYahrzeit(hyear, gdate) ⇒ HDate: Calculates yahrzeit. Year must be after original date of death. Returns undefined when requested year preceeds or is same as original year.
dafyomi(gregdate) ⇒ DafYomiResult: Returns the Daf Yomi for given date
dafname(daf) ⇒ string: Formats (with translation) the dafyomi result as a string like "Pesachim 34"
D(p) ⇒ number: parsha doubler/undoubler
abs(year, absDate) ⇒ Object: Returns an object describing the parsha on the first Saturday on or after absdate
chanukah(day) ⇒ string
getHolidaysForYear(year) ⇒ Map.<string, Array.<Event>>: Returns a Map for the year indexed by HDate.toString()
getHolidaysOnDate(date) ⇒ Array.<Event>: Returns an array of Events on this date (or undefined if no events)
formatTime(timeFormat, dt) ⇒ string
sunsetTime(hd, location, timeFormat, offset) ⇒ Array.<Object>
tzeitTime(hd, location, timeFormat) ⇒ Array.<Object>
candleEvent(e, hd, dow, location, timeFormat, candlesOffset, havdalahOffset) ⇒ Event
getCandleLightingMinutes(options) ⇒ number
getStartAndEnd(options) ⇒ Array.<number>: Parse options object to determine start & end days
getOmerStartAndEnd(hyear) ⇒ Array.<number>
getMaskFromOptions(options) ⇒ number: Mask to filter Holiday array
hebcalEvents(options) ⇒ Array.<Event>: Generates a list of holidays

Typedefs

SimpleHebrewDate : Object: A simple Hebrew date
Molad : Object: Represents an Molad
CityResult : Object: A City result
DafYomiResult : Object: A Daf Yomi result
HebcalOptions : Object: Options to configure which events are returned

HDate

Class representing a Hebrew date

Kind: global class

HDate
- new HDate([day], [month], [year])
- .getFullYear() ⇒ number
- .isLeapYear() ⇒ boolean
- .getMonth() ⇒ number
- .getTishreiMonth() ⇒ number
- .daysInMonth() ⇒ number
- .getDate() ⇒ number
- .getDay() ⇒ number
- .setFullYear(year) ⇒ HDate
- .setMonth(month) ⇒ HDate
- .setTishreiMonth(month) ⇒ HDate
- .setDate(date) ⇒ HDate
- .greg() ⇒ Date
- .abs() ⇒ number
- .getMonthName() ⇒ string
- .render() ⇒ string
- .before(day) ⇒ HDate
- .onOrBefore(day) ⇒ HDate
- .nearest(day) ⇒ HDate
- .onOrAfter(day) ⇒ HDate
- .after(day) ⇒ HDate
- .next() ⇒ HDate
- .prev() ⇒ HDate
- .isSameDate(other) ⇒ boolean

new HDate([day], [month], [year])

Create a Hebrew date.

Param	Type	Description
[day]	`number` \| `Date` \| `HDate`	Day of month (1-30)
[month]	`number`	Hebrew month of year (1=NISAN, 7=TISHREI)
[year]	`number`	Hebrew year