npm install hebrew-code-util






Hebrew unicode utilities
In order to use this library, Node.js should be installed.
Then run:
```
npm install hebrew-code-util --save
Following bundles are available:
* hebrew-code-util.js - UMD ES5 version for use in browser, node, etc.hebrew-code-util.min.js
* - minified version of hebrew-code-util.jshebrew-code-util.esm.js
* - ES6 module version, suitable for bundling with other
libraries and applications
The package could also be downloaded directly from:
https://registry.npmjs.org/hebrew-code-util/-/hebrew-code-util-1.0.6.tgz
The final goal for this work is to learn the Word of God as recorded by
Peshitta.
You are welcomed to improve this implementation or provide feedback. Please
feel free to Fork, create a
Pull Request or
submit Issues.
To read quick updates about Peshitta app or post questions or feedback, follow
@peshittap
at or

``
npm install```
npm run build
* hebrewCodeUtil
* .consonantsByName : Object.<string, string>
* .consonants : Array.<string>
* .finalConsonants : Array.<string>
* .withFinalConsonants : Array.<string>
* .toFinalConsonantMap : Object.<string, string>
* .begadkepat : Array.<string>
* .yiddishDigraphs : Array.<string>
* .allConsonants : Array.<string>
* .punctuation : Array.<string>
* .vowelsByName : Object.<string, string>
* .commonVowels : Array.<string>
* .easternCommonVowels : Array.<string>
* .otherVowels : Array.<string>
* .allVowels : Array.<string>
* .diacriticsByName : Array.<string>
* .diacritics : Array.<string>
* .cantillationDiacritics : Array.<string>
* .allDiacritics : Array.<string>
* .dotting : Array.<string>
* .letterAsciiMap : Object.<string, string>
* .isConsonant ⇒ boolean
* .isFinalConsonant ⇒ boolean
* .hasFinalConsonant ⇒ boolean
* .isVowel ⇒ boolean
* .isRegularDiacritic ⇒ boolean
* .isCantillationDiacritic ⇒ boolean
* .isDiacritic ⇒ boolean
* .isPunctuation ⇒ boolean
* .isDotting ⇒ boolean
* .isDotted ⇒ boolean
* .isBegadkepat ⇒ boolean
* .removeDotting ⇒ string
* .endify ⇒ string
* .sort ⇒ number
Kind: static constant of hebrewCodeUtil
Kind: static constant of hebrewCodeUtil
Kind: static constant of hebrewCodeUtil
Kind: static constant of hebrewCodeUtil
Kind: static constant of hebrewCodeUtil
Kind: static constant of hebrewCodeUtil
Kind: static constant of hebrewCodeUtil
Kind: static constant of hebrewCodeUtil
Kind: static constant of hebrewCodeUtil
Kind: static constant of hebrewCodeUtil
Kind: static constant of hebrewCodeUtil
Kind: static constant of hebrewCodeUtil
Kind: static constant of hebrewCodeUtil
Kind: static constant of hebrewCodeUtil
Kind: static constant of hebrewCodeUtil
Kind: static constant of hebrewCodeUtil
Kind: static constant of hebrewCodeUtil
Kind: static constant of hebrewCodeUtil
Kind: static constant of hebrewCodeUtil
Kind: static constant of hebrewCodeUtil
Kind: static constant of hebrewCodeUtil
Returns: boolean - true if c is Hebrew consonant
| Param | Type | Description |
| --- | --- | --- |
| c | string | input character |
Kind: static constant of hebrewCodeUtil
Returns: boolean - true if c is Hebrew final consonant
| Param | Type | Description |
| --- | --- | --- |
| c | string | input character |
Kind: static constant of hebrewCodeUtil
Returns: boolean - true if c is Hebrew consonant with final pair
| Param | Type | Description |
| --- | --- | --- |
| c | string | input character |
Kind: static constant of hebrewCodeUtil
Returns: boolean - true if c is a vowel
| Param | Type | Description |
| --- | --- | --- |
| c | string | input character |
Kind: static constant of hebrewCodeUtil
Returns: boolean - true if c is a regular diacritic
| Param | Type | Description |
| --- | --- | --- |
| c | string | input character |
Kind: static constant of hebrewCodeUtil
Returns: boolean - true if c is a cantillation diacritic
| Param | Type | Description |
| --- | --- | --- |
| c | string | input character |
Kind: static constant of hebrewCodeUtil
Returns: boolean - true if c is a diacritic
| Param | Type | Description |
| --- | --- | --- |
| c | string | input character |
Kind: static constant of hebrewCodeUtil
Returns: boolean - true if c is punctuation
| Param | Type | Description |
| --- | --- | --- |
| c | string | input character |
Kind: static constant of hebrewCodeUtil
Returns: boolean - true if c is dotting
| Param | Type | Description |
| --- | --- | --- |
| c | string | input character |
Kind: static constant of hebrewCodeUtil
Returns: boolean - true if word has vowels or diacritics
| Param | Type | Description |
| --- | --- | --- |
| word | string | input Hebrew unicode word |
Kind: static constant of hebrewCodeUtil
Returns: boolean - true if c is begadkepat
| Param | Type | Description |
| --- | --- | --- |
| c | string | input character |
Kind: static constant of hebrewCodeUtil
Returns: string - consonantal word
| Param | Type | Description |
| --- | --- | --- |
| word | string | input word to be processed |
Kind: static constant of hebrewCodeUtil
Returns: string - word with end consonant corrected
| Param | Type | Description |
| --- | --- | --- |
| word | string | input word |
Kind: static constant of hebrewCodeUtil
Returns: number - -1, 0, 1 depending on word sorting
| Param | Type | Description |
| --- | --- | --- |
| word1 | string | first word to compare |
| word2 | string | second word to compare |