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

    Function getHolidayDescription

    • Returns a description of the holiday. Uses the English description by default, or the Hebrew description when locale is a Hebrew locale. Returns an empty string if no description is available.

      Parameters

      • ev: Event

        the holiday event to describe

      • firstSentence: boolean = false

        true to truncate the description at the first sentence (up to and excluding the first .)

      • Optionallocale: string

        the locale to render the description in; Hebrew locales (e.g. 'he') get the Hebrew description, everything else gets English

      Returns string

      the holiday description, or '' if none is found