@hebcal/core
Version:
A perpetual Jewish Calendar API
38 lines (37 loc) • 1.25 kB
TypeScript
import { HDate } from '@hebcal/hdate';
import { Event } from './event';
import './locale';
/** Daily Hebrew date ("11th of Sivan, 5780") */
export declare class HebrewDateEvent extends Event {
/**
* @param date
*/
constructor(date: HDate);
/**
* @param [locale] Optional locale name (defaults to empty locale)
* @example
* import {HDate, HebrewDateEvent, months} from '@hebcal/core';
*
* const hd = new HDate(15, months.CHESHVAN, 5769);
* const ev = new HebrewDateEvent(hd);
* console.log(ev.render('en')); // '15th of Cheshvan, 5769'
* console.log(ev.render('he')); // 'ט״ו חֶשְׁוָן תשס״ט'
*/
render(locale?: string): string;
/**
* @private
* @param locale
*/
private renderBriefHebrew;
/**
* @param [locale] Optional locale name (defaults to empty locale)
* @example
* import {HDate, HebrewDateEvent, months} from '@hebcal/core';
*
* const hd = new HDate(15, months.CHESHVAN, 5769);
* const ev = new HebrewDateEvent(hd);
* console.log(ev.renderBrief()); // '15th of Cheshvan'
* console.log(ev.renderBrief('he')); // 'ט״ו חֶשְׁוָן'
*/
renderBrief(locale?: string): string;
}