Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →

@hebcal/core

Package Overview

Dependencies

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

@hebcal/core

A perpetual Jewish Calendar API

1.1.4
Source
npm

Version published: 4 years ago

Weekly downloads: 3.1K; increased by120.65%

Maintainers: 1

Weekly downloads

Created: 4 years ago

Source

hebcal-es6

Hebcal, a perpetual Jewish Calendar (ES6)

Installation

$ npm install @hebcal/core

Synopsis

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

const options = {
  year: 1981,
  isHebrewYear: false,
  candlelighting: true,
  location: Location.lookup('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
HebrewDateEvent: Daily Hebrew date ("11th of Sivan, 5780")
Location: Class representing Location
Sedra: Represents Parashah HaShavua for an entire Hebrew year

Objects

common$1 : object: Common hebrew date routines
dafyomi$2 : object: Daf Yomi
greg$1 : object: Gregorian date routines
holidays$1 : object: Lower-level holidays interface
hebcal : object: Main interface to Hebcal

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.
registerLocation(cityName, location) ⇒ boolean: 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.
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)
reformatTimeStr(timeStr, suffix, options) ⇒ string: Returns "8:13p" for US or "20:13" for any other locale/country
makeAnchor(s) ⇒ string
getHolidayBasename(desc) ⇒ string
getUrlInternal(e, hostname, dirs) ⇒ string
getShortUrl(e) ⇒ string: Gets a short redirector URL for hebcal.com
getEventUrl(e) ⇒ string: Gets a regular (long, non-redirector) URL for hebcal.com
registerLocale(locale, data): Registers a ttag locale for hebcal.hebrewCalendar()
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
getAbs(d) ⇒ number: Gets the Julian absolute days for a number, Date, or HDate
getStartAndEnd(options) ⇒ Array.<number>: Parse options object to determine start & end days
getOmerStartAndEnd(hyear) ⇒ Array.<number>
getMaskFromOptions(options) ⇒ number: Mask to filter Holiday array
hebrewCalendar(options) ⇒ Array.<Event>: Generates a list of holidays

Typedefs

SimpleHebrewDate : Object: A simple Hebrew date
Molad : Object: Represents an Molad
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

hDate.getFullYear() ⇒ `number`

Gets the Hebrew year of this Hebrew date

Kind: instance method of HDate

hDate.isLeapYear() ⇒ `boolean`

Tests if this date occurs during a leap year

Kind: instance method of HDate

hDate.getMonth() ⇒ `number`

Gets the Hebrew month (1=NISAN, 7=TISHREI) of this Hebrew date

Kind: instance method of HDate

hDate.getTishreiMonth() ⇒ `number`

Kind: instance method of HDate

hDate.daysInMonth() ⇒ `number`

Number of days in the month of this Hebrew date

Kind: instance method of HDate

hDate.getDate() ⇒ `number`

Gets the day within the month (1-30)

Kind: instance method of HDate

hDate.getDay() ⇒ `number`

Gets the day of the week, using local time.

Kind: instance method of HDate

hDate.setFullYear(year) ⇒ `HDate`

Kind: instance method of HDate

Param	Type
year	`number`

hDate.setMonth(month) ⇒ `HDate`

Kind: instance method of HDate

Param	Type
month	`number`

hDate.setTishreiMonth(month) ⇒ `HDate`

Kind: instance method of HDate

Param	Type
month	`number`

hDate.setDate(date) ⇒ `HDate`

Kind: instance method of HDate

Param	Type
date	`number`

hDate.greg() ⇒ `Date`

Converts to Gregorian date

Kind: instance method of HDate

hDate.abs() ⇒ `number`

Returns Julian absolute days

Kind: instance method of HDate

hDate.getMonthName() ⇒ `string`

Returns untranslated Hebrew month name

Kind: instance method of HDate

hDate.render() ⇒ `string`

Returns translated/transliterated Hebrew date

Kind: instance method of HDate

hDate.before(day) ⇒ `HDate`

Kind: instance method of HDate

Param	Type	Description
day	`number`	day of week

hDate.onOrBefore(day) ⇒ `HDate`

Kind: instance method of HDate

Param	Type	Description
day	`number`	day of week

hDate.nearest(day) ⇒ `HDate`

Kind: instance method of HDate

Param	Type	Description
day	`number`	day of week

hDate.onOrAfter(day) ⇒ `HDate`

Kind: instance method of HDate

Param	Type	Description
day	`number`	day of week

hDate.after(day) ⇒ `HDate`

Kind: instance method of HDate

Param	Type	Description
day	`number`	day of week

hDate.next() ⇒ `HDate`

Kind: instance method of HDate

hDate.prev() ⇒ `HDate`

Kind: instance method of HDate

hDate.isSameDate(other) ⇒ `boolean`

Kind: instance method of HDate

Param	Type	Description
other	`HDate`	Hebrew date to compare

Event

Represents an Event with a title, date, and flags

Kind: global class

Event
- new Event(date, desc, [mask], [attrs])
- .getFlags() ⇒ number
- .getAttrs() ⇒ Object
- .observedInIsrael() ⇒ boolean
- .observedInDiaspora() ⇒ boolean
- .render() ⇒ string
- .getDesc() ⇒ string
- .getDate() ⇒ HDate

new Event(date, desc, [mask], [attrs])

Constructs Event

Param	Type	Default	Description
date	`HDate`		Hebrew date event occurs
desc	`string`		Description (not translated)
[mask]	`number`	`0`	optional holiday flags
[attrs]	`Object`	`{}`

event.getFlags() ⇒ `number`

Kind: instance method of Event

event.getAttrs() ⇒ `Object`

Kind: instance method of Event

event.observedInIsrael() ⇒ `boolean`

Is this event observed in Israel?

Kind: instance method of Event

event.observedInDiaspora() ⇒ `boolean`

Is this event observed in the Diaspora?

Kind: instance method of Event

event.render() ⇒ `string`

Returns (translated) description of this event

Kind: instance method of Event

event.getDesc() ⇒ `string`

Returns untranslated description of this event

Kind: instance method of Event

event.getDate() ⇒ `HDate`

Returns Hebrew date of this event

Kind: instance method of Event

OmerEvent

Represents a day 1-49 of counting the Omer from Pesach to Shavuot

Kind: global class

OmerEvent
- new OmerEvent(date, omerDay)
- .render() ⇒ string

new OmerEvent(date, omerDay)

Param	Type
date	`HDate`
omerDay	`number`

omerEvent.render() ⇒ `string`

Kind: instance method of OmerEvent
Todo

use gettext()

DafYomiEvent

For a Daf Yomi, the name is already translated attrs.dafyomi.name contains the untranslated string

Kind: global class

DafYomiEvent
- new DafYomiEvent(date, desc, attrs)
- .render() ⇒ string

new DafYomiEvent(date, desc, attrs)

Param	Type
date	`HDate`
desc	`string`
attrs	`Object`

dafYomiEvent.render() ⇒ `string`

Kind: instance method of DafYomiEvent

HavdalahEvent

Havdalah after Shabbat or holiday

Kind: global class

HavdalahEvent
- new HavdalahEvent(date, mask, attrs, [havdalahMins])
- .render() ⇒ string

new HavdalahEvent(date, mask, attrs, [havdalahMins])

Param	Type
date	`HDate`
mask	`number`
attrs	`Object`
[havdalahMins]	`number`

havdalahEvent.render() ⇒ `string`

Kind: instance method of HavdalahEvent

CandleLightingEvent

Candle lighting before Shabbat or holiday

Kind: global class

CandleLightingEvent
- new CandleLightingEvent(date, mask, attrs)
- .render() ⇒ string

new CandleLightingEvent(date, mask, attrs)

Param	Type
date	`HDate`
mask	`number`
attrs	`Object`

candleLightingEvent.render() ⇒ `string`

Kind: instance method of CandleLightingEvent

HebrewDateEvent

Daily Hebrew date ("11th of Sivan, 5780")

Kind: global class

HebrewDateEvent
- new HebrewDateEvent(date, locale)
- .render() ⇒ string

new HebrewDateEvent(date, locale)

Param	Type
date	`HDate`
locale	`string`

hebrewDateEvent.render() ⇒ `string`

Kind: instance method of HebrewDateEvent

Location

Class representing Location

Kind: global class

Location
- new Location(latitude, longitude, il, tzid, cityName, countryCode, geoid)
- instance
  - .getLatitude() ⇒ number
  - .getLongitude() ⇒ number
  - .getIsrael() ⇒ boolean
  - .getName() ⇒ string
  - .getCountryCode() ⇒ string
  - .getTzid() ⇒ string
  - .suntime(hdate) ⇒ suncalc.GetTimesResult
  - .sunrise(hdate) ⇒ Date
  - .sunset(hdate) ⇒ Date
  - .hour(hdate) ⇒ number
  - .hourMins(hdate) ⇒ number
  - .gregEve(hdate) ⇒ Date
  - .nightHour(hdate) ⇒ number
  - .nightHourMins(hdate) ⇒ number
  - .hourOffset(hdate, hours) ⇒ Date
  - .chatzot(hdate) ⇒ Date
  - .chatzotNight(hdate) ⇒ Date
  - .alotHaShachar(hdate) ⇒ Date
  - .misheyakir(hdate) ⇒ Date
  - .misheyakirMachmir(hdate) ⇒ Date
  - .sofZmanShma(hdate) ⇒ Date
  - .sofZmanTfilla(hdate) ⇒ Date
  - .minchaGedola(hdate) ⇒ Date
  - .minchaKetana(hdate) ⇒ Date
  - .plagHaMincha(hdate) ⇒ Date
  - .tzeit(hdate) ⇒ Date
  - .neitzHaChama(hdate) ⇒ Date
  - .shkiah(hdate) ⇒ Date
- static
  - .lookup(name) ⇒ Location