@hebcal/rest-api
    Preparing search index...

    Type Alias ClassicApiItem

    A single event as rendered for the classic Hebcal.com JSON API, as produced by eventToClassicApiObject()

    type ClassicApiItem = {
        category: string;
        date: string;
        ev?: Event;
        hdate?: string;
        hebrew?: string;
        heDateParts?: { d: string; m: string; y: string };
        leyning?: StringMap;
        link?: string;
        memo?: string;
        molad?: {
            chalakim: number;
            dow: number;
            hm: string;
            hour: number;
            hy: number;
            instant: string;
            minutes: number;
        };
        omer?: {
            anaBekoachWord: string;
            count: { en: string; he: string };
            lamnatzeachLetter: string;
            lamnatzeachWord: string;
            sefira: { en: string; he: string; translit: string };
        };
        subcat?: string;
        title: string;
        title_orig?: string;
        yomtov?: boolean;
    }
    Index
    category date ev? hdate? hebrew? heDateParts? leyning? link? memo? molad? omer? subcat? title title_orig? yomtov?
    category: string

    category, e.g. 'holiday', 'roshchodesh', 'candles' (see getEventCategories())

    date: string

    ISO 8601 date (or date+time, for timed events)

    ev?: Event

    the underlying Event object, present only when RestApiEventOptions.includeEvent is set

    hdate?: string

    Hebrew date rendered as a string, omitted for timed events

    hebrew?: string

    Hebrew rendering of the title (he-x-NoNikud locale, no vowel points)

    heDateParts?: { d: string; m: string; y: string }

    Hebrew date broken into gematriya-rendered parts, present when RestApiEventOptions.heDateParts is set (or the event itself is a Hebrew-date event)

    leyning?: StringMap

    Torah/Haftarah readings, when applicable

    link?: string

    URL with tracking parameters appended, for events that have one (see appendIsraelAndTracking())

    memo?: string

    holiday description or linked-event text, when available

    molad?: {
        chalakim: number;
        dow: number;
        hm: string;
        hour: number;
        hy: number;
        instant: string;
        minutes: number;
    }

    Molad (new moon) details, present only for Molad announcement events

    omer?: {
        anaBekoachWord: string;
        count: { en: string; he: string };
        lamnatzeachLetter: string;
        lamnatzeachWord: string;
        sefira: { en: string; he: string; translit: string };
    }

    Sefirat HaOmer count details, present only for Omer-count events

    subcat?: string

    subcategory, e.g. 'major', 'minor'

    title: string

    rendered event title, e.g. 'Rosh Hashana' or 'Candle lighting: 7:14pm'

    title_orig?: string

    original (non-brief) event description, present when it differs from title

    yomtov?: boolean

    true if this is a Yom Tov holiday

    Settings
    Member Visibility

    On This Page
    Properties