@hebcal/locale-base

@hebcal/locale-base

Jewish holiday translations/transliterations

Locale

A locale in Hebcal is used for translations/transliterations of holidays. @hebcal/core 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. "שבת")

Kind: global class

• Locale
  • .lookupTranslation(id, [locale]) ⇒ string
  • .gettext(id, [locale]) ⇒ string
  • .addLocale(locale, data)
  • .addTranslation(locale, id, translation)
  • .addTranslations(locale, data)
  • .useLocale(locale)
  • .getLocaleName() ⇒ string
  • .getLocaleNames() ⇒ Array.<string>
  • .ordinal(n, [locale]) ⇒ string
  • .hebrewStripNikkud(str) ⇒ string

Locale.lookupTranslation(id, [locale]) ⇒ string

Returns translation only if locale offers a non-empty translation for id. Otherwise, returns undefined.

Kind: static method of Locale

Param	Type	Description
id	string	Message ID to translate
[locale]	string	Optional locale name (i.e: 'he', 'fr'). Defaults to active locale.

Locale.gettext(id, [locale]) ⇒ string

By default, if no translation was found, returns id.

Kind: static method of Locale

Param	Type	Description
id	string	Message ID to translate
[locale]	string	Optional locale name (i.e: 'he', 'fr'). Defaults to active locale.

Locale.addLocale(locale, data)

Register locale translations.

Kind: static method of Locale

Param	Type	Description
locale	string	Locale name (i.e.: 'he', 'fr')
data	LocaleData	parsed data from a .po file.

Locale.addTranslation(locale, id, translation)

Adds a translation to locale, replacing any previous translation.

Kind: static method of Locale

Param	Type	Description
locale	string	Locale name (i.e: 'he', 'fr').
id	string	Message ID to translate
translation	string	Translation text

Locale.addTranslations(locale, data)

Adds multiple translations to locale, replacing any previous translations.

Kind: static method of Locale

Param	Type	Description
locale	string	Locale name (i.e: 'he', 'fr').
data	LocaleData	parsed data from a .po file.

Locale.useLocale(locale)

Activates a locale. Throws an error if the locale has not been previously added. After setting the locale to be used, all strings marked for translations will be represented by the corresponding translation in the specified locale.

Kind: static method of Locale

Param	Type	Description
locale	string	Locale name (i.e: 'he', 'fr')

Locale.getLocaleName() ⇒ string

Returns the name of the active locale (i.e. 'he', 'ashkenazi', 'fr')

Kind: static method of Locale

Locale.getLocaleNames() ⇒ Array.<string>

Returns the names of registered locales

Kind: static method of Locale

Locale.ordinal(n, [locale]) ⇒ string

Kind: static method of Locale

Param	Type	Description
n	number
[locale]	string	Optional locale name (i.e: 'he', 'fr'). Defaults to active locale.

Locale.hebrewStripNikkud(str) ⇒ string

Removes nekudot from Hebrew string

Kind: static method of Locale

Param	Type
str	string