@hebcal/core/dist/esm/holidays.d.ts

A perpetual Jewish Calendar API

import { HDate } from '@hebcal/hdate';
import { HolidayEvent } from './HolidayEvent';
/**
 * Returns an array of Events on this date (or `undefined` if no events)
 * @param date Hebrew Date, Gregorian date, or absolute R.D. day number
 * @param [il] use the Israeli schedule for holidays
 */
export declare function getHolidaysOnDate(date: HDate | Date | number, il?: boolean): HolidayEvent[] | undefined;
export type HolidayYearMap = Map<string, HolidayEvent[]>;
/**
 * Lower-level holidays interface, which returns a `Map` of `Event`s indexed by
 * `HDate.toString()`. These events must filtered especially for `flags.IL_ONLY`
 * or `flags.CHUL_ONLY` depending on Israel vs. Diaspora holiday scheme.
 * @private
 */
export declare function getHolidaysForYear_(year: number): HolidayYearMap;
/**
 * Returns an array of holidays for the year
 * @param year Hebrew year
 * @param il use the Israeli schedule for holidays
 */
export declare function getHolidaysForYearArray(year: number, il: boolean): HolidayEvent[];