@hebcal/core/dist/candles.d.ts

A perpetual Jewish Calendar API

import { HDate } from '@hebcal/hdate';
import { CalOptions } from './CalOptions';
import { Location } from './location';
import { Event } from './event';
import { ChanukahEvent, HolidayEvent } from './HolidayEvent';
import { TimedEvent } from './TimedEvent';
/**
 * @private
 */
export declare function makeCandleEvent(ev: Event | undefined, hd: HDate, options: CalOptions, isFriday: boolean, isSaturday: boolean): TimedEvent | undefined;
/** A fast day also contains a start and end time */
export declare class FastDayEvent extends HolidayEvent {
    /** original event */
    readonly linkedEvent: HolidayEvent;
    /** this will be a "Fast begins" event */
    readonly startEvent?: TimedEvent;
    /** this will be a "Fast ends" event */
    readonly endEvent?: TimedEvent;
    constructor(linkedEvent: HolidayEvent, startEvent?: TimedEvent, endEvent?: TimedEvent);
    render(locale?: string): string;
    renderBrief(locale?: string): string;
    urlDateSuffix(): string;
    url(): string | undefined;
    getEmoji(): string;
    getCategories(): string[];
}
/**
 * Makes a pair of events representing fast start and end times
 * @private
 */
export declare function makeFastStartEnd(ev: HolidayEvent, options: CalOptions): FastDayEvent;
export declare class TimedChanukahEvent extends ChanukahEvent {
    eventTime: Date;
    eventTimeStr: string;
    readonly location: Location;
    constructor(date: HDate, desc: string, mask: number, eventTime: Date, location: Location);
}
/**
 * Makes a candle-lighting event for Chankah (not on Friday/Saturday).
 * At one point this used civil dusk (6 degrees below horizon).
 * Another source suggests 4.6667 degrees below horizon.
 * @private
 */
export declare function makeWeekdayChanukahCandleLighting(ev: HolidayEvent, hd: HDate, options: CalOptions): TimedChanukahEvent | null;