dayjs-hebcal-plugin

Hebcal plugin for Dayjs

dayjs().hebcal().format();

Getting Started

Installation

bun add dayjs @wyesoftware/dayjs-hebcal-plugin

pnpm add dayjs @wyesoftware/dayjs-hebcal-plugin

yarn add dayjs @wyesoftware/dayjs-hebcal-plugin

Usage

import dayjs from "dayjs";
import hebcal from "@wyesoftware/dayjs-hebcal-plugin";
dayjs.extend(hebcal);

console.log(dayjs().hebcal().format());

API

Init

[Optional] use the Israeli schedule for holidays

dayjs().hebcal(israeli?: boolean); // default false

function isHoliday()

Returns true if date is Hebrew holiday

dayjs().hebcal().isHoliday(); // () => boolean

function getHolidays()

Returns an array of holidays on this date

dayjs().hebcal().getHolidays(); // () => string[]

function format()

Returns formatted Hebrew date (default: "DDD MMM YYY")

dayjs().hebcal().format(formatStr?: string); // () => string

Supported Formats