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

    Type Alias ClassicApiResult

    The classic Hebcal.com JSON API response envelope, as produced by eventsToClassicApiHeader() and eventsToClassicApi()

    type ClassicApiResult = {
        date: string;
        items?: ClassicApiItem[];
        location: LocationPlainObj;
        range?: { end: string; start: string };
        tachanun?: TachanunResult;
        title: string;
        version: string;
    }
    Index
    date items? location range? tachanun? title version
    date: string

    ISO 8601 timestamp of when this response was generated

    items?: ClassicApiItem[]

    the events, present when generated via eventsToClassicApi()

    location: LocationPlainObj
    range?: { end: string; start: string }

    ISO 8601 start/end dates spanned by items

    tachanun?: TachanunResult

    whether Tachanun is recited, present when RestApiEventOptions.tachanun is set and the range is a single day

    title: string

    calendar title, see getCalendarTitle()

    version: string

    @hebcal/core package version

    Settings
    Member Visibility

    On This Page
    Properties