1.0.0 • Published 3 years ago

heb-date v1.0.0

Weekly downloads
-
License
ISC
Repository
github
Last release
3 years ago

HebrewDate

A small wrapper around libhdate that should make it much easier to use.

API

new HebrewDate(options)

Where options are:

  • date: Date - optional - The day to user. Defaults to new Date().
  • isDiaspora: Boolean - optional - Should be calculated according to Israel (default) or diaspora.

Instance properties

  • year: number - Returns the Hebrew year number, e.g. 5782.
  • month: number - Returns the Hebrew month number, zero based (same as native JS Date object).
Month numberMonth name (English)Month name (Hebrew)
0Tishriתשרי
1Heshvanחשוון
2Kislevכסלו
3Tevetטבת
4Shevatשבט
5Adarאדר (בשנה לא מעוברת)
6Nisanניסן
7Iyarאייר
8Sivanסיוון
9Tammuzתמוז
10Avאב
11Elulאלול
12Adar I'אדר א
13Adar II'אדר ב
  • date: number - Returns the Hebrew numerical value of the day in the month.

  • holiday: number | undefined - Returns the holiday in the Hebrew calendar, if any.

  • holidayName: string | undefined - Returns the holiday name, in Hebrew, if any.

example:

const HebrewDate = require('hebrew-date')

// With specific date object
const date = new Date('2021-09-21');
const hdate = new HebrewDate({ date });
console.log(`September 21st, 2021 hebrew date is: ${hdate.date}, in month ${hdate.month}, in Year ${hdate.year}, and holiday ${hdate.holiday} - which is ${hdate.holidayName}`)

// Outputs
// September 21st, 2021 hebrew date is: 15, in month 0, in Year 5782, and holiday 5 - which is סוכות