import { HDate } from '@hebcal/hdate'; import { CalOptions } from './CalOptions'; import { Location } from './location'; import { Event } from './event'; import './locale'; /** * Base class for events that have an associated wall-clock time and * geographic location — for example, candle lighting, havdalah, and * fast begin/end times. * * Stores both a `Date` (`eventTime`) and pre-formatted 24-hour * (`eventTimeStr`) and locale-aware (`fmtTime`) strings. May reference a * "linked" event such as the holiday whose candle-lighting time this * represents. */ export declare class TimedEvent extends Event { /** The exact moment of the event, rounded to the nearest minute */ readonly eventTime: Date; /** Geographic location used to compute `eventTime` */ readonly location: Location; /** 24-hour formatted time string in the location's timezone (e.g. `"19:42"`) */ readonly eventTimeStr: string; /** Locale-aware formatted time string (e.g. `"7:42pm"` in US locale) */ readonly fmtTime: string; /** Optional event this time is associated with (e.g. the Yom Tov being lit for) */ readonly linkedEvent?: Event; /** * @param desc Description (not translated) */ constructor(date: HDate, desc: string, mask: number, eventTime: Date, location: Location, linkedEvent?: Event, options?: CalOptions); /** * @param [locale] Optional locale name (defaults to empty locale) */ render(locale?: string): string; /** * Returns translation of "Candle lighting" without the time. * @param [locale] Optional locale name (defaults to empty locale) */ renderBrief(locale?: string): string; getCategories(): string[]; } /** * Candle-lighting event for the eve of Shabbat or a Yom Tov. * * Generated by {@link HebrewCalendar.calendar} when `options.candlelighting` * is `true` and `options.location` is provided. By default candle lighting * occurs 18 minutes before sundown (40 minutes in Jerusalem; 30 minutes in * Haifa and Zikhron Ya'akov), configurable via `options.candleLightingMins`. */ export declare class CandleLightingEvent extends TimedEvent { constructor(date: HDate, mask: number, eventTime: Date, location: Location, linkedEvent?: Event, options?: CalOptions); getEmoji(): string; } /** * Havdalah event marking the end of Shabbat or a Yom Tov. * * Generated by {@link HebrewCalendar.calendar} when `options.candlelighting` * is `true` and `options.location` is provided. By default Havdalah is * calculated by *tzeit hakochavim* (8.5° solar depression); pass * `options.havdalahMins` to use a fixed minute offset instead, or * `options.havdalahDeg` to use a different degree. */ export declare class HavdalahEvent extends TimedEvent { private readonly havdalahMins?; constructor(date: HDate, mask: number, eventTime: Date, location: Location, havdalahMins?: number, linkedEvent?: Event, options?: CalOptions); /** * @param [locale] Optional locale name (defaults to empty locale) */ render(locale?: string): string; /** * Returns translation of "Havdalah" without the time. * @param [locale] Optional locale name (defaults to empty locale) */ renderBrief(locale?: string): string; getEmoji(): string; }