@hebcal/core 4.1.1 → 4.3.0

package/README.md

@@ -142,6 +142,12 @@ parshiot[0] == 'Bereshit', parshiot[1] == 'Noach', parshiot[53]
 <p>When specifying years of the Hebrew calendar in the present millennium,
 we omit the thousands (which is presently 5 [ה]).</p>
 </dd>
+<dt><a href="#gematriyaStrToNum">gematriyaStrToNum(str)</a> ⇒ <code>number</code></dt>
+<dd><p>Converts a string of Hebrew letters to a numerical value.</p>
+<p>Only considers the value of Hebrew letters <code>א</code> through <code>ת</code>.
+Ignores final Hebrew letters such as <code>ך</code> (kaf sofit) or <code>ם</code> (mem sofit)
+and vowels (nekudot).</p>
+</dd>
 </dl>
 
 ## Typedefs
@@ -175,6 +181,8 @@ holidays. `@hebcal/core` supports four locales by default
     * [.lookupTranslation(id, [locale])](#Locale.lookupTranslation) ⇒ <code>string</code>
     * [.gettext(id, [locale])](#Locale.gettext) ⇒ <code>string</code>
     * [.addLocale(locale, data)](#Locale.addLocale)
+    * [.addTranslation(locale, id, translation)](#Locale.addTranslation)
+    * [.addTranslations(locale, data)](#Locale.addTranslations)
     * [.useLocale(locale)](#Locale.useLocale) ⇒ <code>LocaleData</code>
     * [.getLocaleName()](#Locale.getLocaleName) ⇒ <code>string</code>
     * [.getLocaleNames()](#Locale.getLocaleNames) ⇒ <code>Array.&lt;string&gt;</code>
@@ -218,6 +226,31 @@ Register locale translations.
 | locale | <code>string</code> | Locale name (i.e.: `'he'`, `'fr'`) |
 | data | <code>LocaleData</code> | parsed data from a `.po` file. |
 
+<a name="Locale.addTranslation"></a>
+
+### Locale.addTranslation(locale, id, translation)
+Adds a translation to `locale`, replacing any previous translation.
+
+**Kind**: static method of [<code>Locale</code>](#Locale)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| locale | <code>string</code> | Locale name (i.e: `'he'`, `'fr'`). |
+| id | <code>string</code> | Message ID to translate |
+| translation | <code>string</code> | Translation text |
+
+<a name="Locale.addTranslations"></a>
+
+### Locale.addTranslations(locale, data)
+Adds multiple translations to `locale`, replacing any previous translations.
+
+**Kind**: static method of [<code>Locale</code>](#Locale)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| locale | <code>string</code> | Locale name (i.e: `'he'`, `'fr'`). |
+| data | <code>LocaleData</code> | parsed data from a `.po` file. |
+
 <a name="Locale.useLocale"></a>
 
 ### Locale.useLocale(locale) ⇒ <code>LocaleData</code>
@@ -311,6 +344,7 @@ Represents a Hebrew date
         * [.monthFromName(monthName)](#HDate.monthFromName) ⇒ <code>number</code>
         * [.dayOnOrBefore(dayOfWeek, absdate)](#HDate.dayOnOrBefore) ⇒ <code>number</code>
         * [.isHDate(obj)](#HDate.isHDate) ⇒ <code>boolean</code>
+        * [.fromGematriyaString(str, currentThousands)](#HDate.fromGematriyaString) ⇒ [<code>HDate</code>](#HDate)
 
 <a name="new_HDate_new"></a>
 
@@ -782,6 +816,24 @@ Tests if the object is an instance of `HDate`
 | --- | --- |
 | obj | <code>any</code> | 
 
+<a name="HDate.fromGematriyaString"></a>
+
+### HDate.fromGematriyaString(str, currentThousands) ⇒ [<code>HDate</code>](#HDate)
+Construct a new instance of `HDate` from a Gematriya-formatted string
+
+**Kind**: static method of [<code>HDate</code>](#HDate)  
+
+| Param | Type | Default |
+| --- | --- | --- |
+| str | <code>string</code> |  | 
+| currentThousands | <code>number</code> | <code>5000</code> | 
+
+**Example**  
+```js
+HDate.fromGematriyaString('כ״ז בְּתַמּוּז תשפ״ג') // 27 Tamuz 5783
+ HDate.fromGematriyaString('כ׳ סיון תש״ד') // 20 Sivan 5704
+ HDate.fromGematriyaString('ה׳ אִיָיר תש״ח') // 5 Iyyar 5708
+```
 <a name="Event"></a>
 
 ## Event
@@ -2692,6 +2744,21 @@ gematriya(60) // 'ס׳'
 gematriya(3761) // 'ג׳תשס״א'
 gematriya(1123) // 'א׳קכ״ג'
 ```
+<a name="gematriyaStrToNum"></a>
+
+## gematriyaStrToNum(str) ⇒ <code>number</code>
+Converts a string of Hebrew letters to a numerical value.
+
+Only considers the value of Hebrew letters `א` through `ת`.
+Ignores final Hebrew letters such as `ך` (kaf sofit) or `ם` (mem sofit)
+and vowels (nekudot).
+
+**Kind**: global function  
+
+| Param | Type |
+| --- | --- |
+| str | <code>string</code> | 
+
 <a name="ZmanimTimesResult"></a>
 
 ## ZmanimTimesResult : <code>Object</code>