![\"Jewish](\"assets/jewish-date.svg\")
\n\nJewish Date is a fast and modern 2kb alternative to hebcal with an MIT license.
\n\n\n> Jewish Date is a fast and modern 2kB JavaScript library that provides a simple and efficient Gregorian-to-Hebrew and vice versa date converter. With an MIT license and seamless compatibility with all browsers, node.js, and TypeScript, Jewish Date is a reliable and efficient date converter that can help you convert dates between the Hebrew and Gregorian calendars with ease.\n\n\n- 馃摝 2kb mini library (minified & gzip)\n- 馃摐 MIT License\n- 馃敡 Easy to use\n- 馃捇 Seamless compatibility with both Node.js and the browser\n\n# Getting Started\n\n## Installation\n\n```console\nyarn add jewish-date\n```\n\nOr with npm\n\n```console\nnpm install jewish-date --save\n```\n\n## Usage\n\n### TypeScript & ES6 example\n\n```js\nimport {\n toJewishDate,\n formatJewishDate,\n toHebrewJewishDate,\n formatJewishDateInHebrew,\n toGregorianDate,\n JewishMonth,\n} from \"jewish-date\";\n\nconst date = new Date(2023, 4, 9); // the month is 0-indexed (4 = May)\nconst jewishDate = toJewishDate(date);\nconsole.log(jewishDate); // { year: 5783, monthName: \"Iyyar\", month: 8, day: 18 }\n\nconst jewishDateInEnglish = formatJewishDate(jewishDate);\nconsole.log(jewishDateInEnglish); // 18 Iyyar 5783\n\n// With custom format pattern (similar to date-fns)\nconst formatted = formatJewishDate(jewishDate, \"dd/MM/yyyy\");\nconsole.log(formatted); // 18/08/5783\n\nconst jewishDateInHebrew = toHebrewJewishDate(jewishDate);\nconsole.log(jewishDateInHebrew); // { day: \"讬状讞\", monthName: \"讗讬讬专\", year: \"讛转砖驻状讙\" }\n\nconst jewishDateInHebrewStr = formatJewishDateInHebrew(jewishDate);\nconsole.log(jewishDateInHebrewStr); // 讬状讞 讗讬讬专 讛转砖驻状讙\n\n// With custom format pattern in Hebrew (gematria)\nconst formattedHebrew = formatJewishDateInHebrew(jewishDate, \"D/MM/YY\");\nconsole.log(formattedHebrew); // 讬状讞/02/驻状讙\n\nconst date2 = toGregorianDate({\n year: 5783,\n monthName: JewishMonth.Iyyar,\n day: 18,\n});\nconsole.log(date2); // Tue May 09 2023 00:00:00 GMT+0300 (Israel Daylight Time)\n```\n\n#### For ES5\n\nReplace\n\n```js\nimport {\n toJewishDate,\n formatJewishDate,\n toHebrewJewishDate,\n formatJewishDateInHebrew,\n toGregorianDate,\n JewishMonth,\n} from \"jewish-date\";\n```\n\nWith\n\n```js\nconst {\n toJewishDate,\n formatJewishDate,\n toHebrewJewishDate,\n formatJewishDateInHebrew,\n toGregorianDate,\n JewishMonth,\n} = require(\"jewish-date\");\n```\n\n## Format Patterns\n\nBoth `formatJewishDate` and `formatJewishDateInHebrew` accept an optional pattern string as the second argument. The pattern uses tokens similar to [date-fns](https://date-fns.org/docs/format).\n\n### Supported Tokens\n\n| Token | Description | `formatJewishDate` | `formatJewishDateInHebrew` |\n| ------ | ------------------------ | ------------------ | -------------------------- |\n| `d` | Day (numeric) | 8 | 8 |\n| `dd` | Day (zero-padded) | 08 | 08 |\n| `D` | Day (gematria in Hebrew) | 8 | 讞壮 |\n| `M` | Month number | 2 | 2 |\n| `MM` | Month number (padded) | 02 | 02 |\n| `MMMM` | Month name | Iyyar | 讗讬讬专 |\n| `yy` | Year short (numeric) | 83 | 83 |\n| `YY` | Year short (gematria) | 83 | 驻状讙 |\n| `yyyy` | Year full (numeric) | 5783 | 5783 |\n| `YYYY` | Year full (gematria) | 5783 | 讛转砖驻状讙 |\n\n### Examples\n\n```js\nconst jewishDate = toJewishDate(new Date(2023, 4, 9)); // 18 Iyyar 5783\n\n// English formatting (default: \"d MMMM yyyy\")\nformatJewishDate(jewishDate); // \"18 Iyyar 5783\"\nformatJewishDate(jewishDate, \"dd/MM/yyyy\"); // \"18/08/5783\"\nformatJewishDate(jewishDate, \"MMMM d, yyyy\"); // \"Iyyar 18, 5783\"\nformatJewishDate(jewishDate, \"yyyy-MM-dd\"); // \"5783-08-18\"\n\n// Hebrew formatting (default: \"D MMMM YYYY\")\nformatJewishDateInHebrew(jewishDate); // \"讬状讞 讗讬讬专 讛转砖驻状讙\"\nformatJewishDateInHebrew(jewishDate, \"D MMMM YYYY\"); // \"讬状讞 讗讬讬专 讛转砖驻状讙\"\nformatJewishDateInHebrew(jewishDate, \"dd/MM/yyyy\"); // \"18/08/5783\" (numeric)\nformatJewishDateInHebrew(jewishDate, \"d MMMM yyyy\"); // \"18 讗讬讬专 5783\" (mixed)\n```\n\n# License\n\nJewish Date is licensed under a [MIT License](https://github.com/Shmulik-Kravitz/jewish-date/blob/master/LICENSE).\n","readmeFilename":"README.md"}![\"npm](\"https://img.shields.io/npm/v/jewish-date.svg\")
\n ![\"Gzip](\"https://img.shields.io/badge/Size-2%20kb-success?style=flat\"){kind=icon}
\n ![\"License\"](\"https://img.shields.io/badge/license-MIT-blue.svg\"){kind=icon}
\n ![\"Build](\"https://github.com/Shmulik-Kravitz/jewish-date/actions/workflows/main.yml/badge.svg\"){kind=icon}
\n ![\"Code](\"https://img.shields.io/badge/Code%20Coverage-100%25-success?style=flat\"){kind=icon}
\n