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

    Type Alias RestApiEventOptions

    Options specific to rendering events for the REST API, as opposed to options in CalOptions that control which events are generated

    type RestApiEventOptions = {
        appendHebrewToSubject?: boolean;
        euro?: boolean;
        heDateParts?: boolean;
        includeEvent?: boolean;
        preferAsciiName?: boolean;
        subscribe?: string | number | boolean;
        tachanun?: boolean;
        utmCampaign?: string;
        utmMedium?: string;
        utmSource?: string;
        yahrzeit?: boolean;
    }
    Index
    appendHebrewToSubject? euro? heDateParts? includeEvent? preferAsciiName? subscribe? tachanun? utmCampaign? utmMedium? utmSource? yahrzeit?
    appendHebrewToSubject?: boolean

    append the Hebrew rendering of the event title to the CSV subject line

    euro?: boolean

    render CSV dates as DD/MM/YYYY (European order) instead of the default MM/DD/YYYY

    heDateParts?: boolean

    include a heDateParts field (Hebrew year/month/day rendered with gematriya) on each classic API event

    includeEvent?: boolean

    include the underlying Event object as the ev field on each classic API event

    preferAsciiName?: boolean

    prefer a location's ASCII name over its short display name when generating a calendar title or download filename

    subscribe?: string | number | boolean

    true, '1', or 1 marks this calendar as a recurring subscription (e.g. a webcal feed); suppresses the year from the generated calendar title since the feed is perpetually up to date

    tachanun?: boolean

    include a tachanun field in the classic API response describing whether Tachanun is recited (only applies when the result covers a single day)

    utmCampaign?: string

    value for the utm_campaign (or hebcal.com-internal uc) tracking parameter appended to event links

    utmMedium?: string

    value for the utm_medium (or hebcal.com-internal um) tracking parameter appended to event links (default 'api')

    utmSource?: string

    value for the utm_source (or hebcal.com-internal us) tracking parameter appended to event links

    yahrzeit?: boolean

    true if this calendar is a Yahrzeit/Anniversary calendar; changes the generated calendar title

    Settings
    Member Visibility

    On This Page
    Properties