Class Locale

A locale in Hebcal is used for translations/transliterations of holidays. @hebcal/hdate supports four locales by default

en - default, Sephardic transliterations (e.g. "Shabbat")
ashkenazi - Ashkenazi transliterations (e.g. "Shabbos")
he - Hebrew (e.g. "שַׁבָּת")
he-x-NoNikud - Hebrew without nikud (e.g. "שבת")

Index

Constructors

Methods

addLocale addTranslation addTranslations copyLocaleNoNikud getLocaleNames gettext hasLocale hebrewStripNikkud lookupTranslation ordinal

Constructors

constructor

new Locale(): Locale
Returns Locale

Methods

`Static`addLocale

addLocale(locale: string, data: LocaleData): void
Register locale translations.
Parameters
- locale: string
  Locale name (i.e.: 'he', 'fr')
- data: LocaleData
  parsed data from a .po file.
Returns void
- Defined in locale.ts:102

`Static`addTranslation

addTranslation(locale: string, id: string, translation: string | string[]): void
Adds a translation to locale, replacing any previous translation.
Parameters
- locale: string
  Locale name (i.e: 'he', 'fr').
- id: string
  Message ID to translate
- translation: string | string[]
  Translation text
Returns void
- Defined in locale.ts:117

`Static`addTranslations

addTranslations(locale: string, data: LocaleData): void
Adds multiple translations to locale, replacing any previous translations.
Parameters
- locale: string
  Locale name (i.e: 'he', 'fr').
- data: LocaleData
  parsed data from a .po file.
Returns void
- Defined in locale.ts:142

`Static`copyLocaleNoNikud

copyLocaleNoNikud(data: LocaleData): LocaleData
Makes a copy of entire Hebrew locale with no niqqud
Parameters
- data: LocaleData
Returns LocaleData
- Defined in locale.ts:206

`Static`getLocaleNames

getLocaleNames(): string[]
Returns the names of registered locales

Returns string[]
- Defined in locale.ts:154

`Static`gettext

gettext(id: string, locale?: string): string
By default, if no translation was found, returns id.
Parameters
- id: string
  Message ID to translate
- Optionallocale: string
  Optional locale name (i.e: 'he', 'fr'). Defaults to no-op locale.
Returns string
- Defined in locale.ts:89

`Static`hasLocale

hasLocale(locale: string): boolean
Checks whether a locale has been registered
Parameters
- locale: string
  Locale name (i.e: 'he', 'fr').
Returns boolean
- Defined in locale.ts:163

`Static`hebrewStripNikkud

hebrewStripNikkud(str: string): string
Removes nekudot from Hebrew string
Parameters
- str: string
Returns string
- Defined in locale.ts:199

`Static`lookupTranslation

lookupTranslation(id: string, locale?: string): string | undefined
Returns translation only if locale offers a non-empty translation for id. Otherwise, returns undefined.
Parameters
- id: string
  Message ID to translate
- Optionallocale: string
  Optional locale name (i.e: 'he', 'fr'). Defaults to no-op locale.
Returns string | undefined
- Defined in locale.ts:73

`Static`ordinal

ordinal(n: number, locale?: string): string
Renders a number in ordinal, such as 1st, 2nd or 3rd
Parameters
- n: number
- Optionallocale: string
  Optional locale name (i.e: 'he', 'fr'). Defaults to no-op locale.
Returns string
- Defined in locale.ts:172