hebrew-code-util

Hebrew unicode utilities

Installation

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.js
• hebrew-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

More information

Peshitta App

Beth Mardutho

CAL

License

MIT

Contributing

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

Development

npm install

npm run build

API Reference

• 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

hebrewCodeUtil.consonantsByName : Object.<string, string>

Hebrew consonant name to value map

Kind: static constant of hebrewCodeUtil

hebrewCodeUtil.consonants : Array.<string>

Hebrew base 22 consonants

Kind: static constant of hebrewCodeUtil

hebrewCodeUtil.finalConsonants : Array.<string>

Hebrew 5 final consonants

Kind: static constant of hebrewCodeUtil

hebrewCodeUtil.withFinalConsonants : Array.<string>

Hebrew 5 with final pair consonants

Kind: static constant of hebrewCodeUtil

hebrewCodeUtil.toFinalConsonantMap : Object.<string, string>

Map from regular to final consonant

Kind: static constant of hebrewCodeUtil

hebrewCodeUtil.begadkepat : Array.<string>

Begadkepat letters

Kind: static constant of hebrewCodeUtil

hebrewCodeUtil.yiddishDigraphs : Array.<string>

Yiddish digraphs

Kind: static constant of hebrewCodeUtil

hebrewCodeUtil.allConsonants : Array.<string>

All Hebrew consonants including final ones and yiddish digraphs

Kind: static constant of hebrewCodeUtil

hebrewCodeUtil.punctuation : Array.<string>

Hebrew punctuation

Kind: static constant of hebrewCodeUtil

hebrewCodeUtil.vowelsByName : Object.<string, string>

Hebrew vowel name to value map

Kind: static constant of hebrewCodeUtil

hebrewCodeUtil.commonVowels : Array.<string>

Hebrew common vowels - common in relation to Syriac

Kind: static constant of hebrewCodeUtil

hebrewCodeUtil.easternCommonVowels : Array.<string>

Hebrew vowels common to eastern syriac

Kind: static constant of hebrewCodeUtil

hebrewCodeUtil.otherVowels : Array.<string>

Rest of Hebrew vowels

Kind: static constant of hebrewCodeUtil

hebrewCodeUtil.allVowels : Array.<string>

All Hebrew vowels

Kind: static constant of hebrewCodeUtil

hebrewCodeUtil.diacriticsByName : Array.<string>

Hebrew regular diacritics name/value map

Kind: static constant of hebrewCodeUtil

hebrewCodeUtil.diacritics : Array.<string>

Hebrew regular diacritics

Kind: static constant of hebrewCodeUtil

hebrewCodeUtil.cantillationDiacritics : Array.<string>

Hebrew cantillation marks

Kind: static constant of hebrewCodeUtil

hebrewCodeUtil.allDiacritics : Array.<string>

All hebrew diacritics

Kind: static constant of hebrewCodeUtil

hebrewCodeUtil.dotting : Array.<string>

Vowels and diacritics: used for consonantal only mapping

Kind: static constant of hebrewCodeUtil

hebrewCodeUtil.letterAsciiMap : Object.<string, string>

Hebrew to ordinal ASCII value. Used for sorting: a b c d e f g h i j k l m n o p q r s t u v w x y z { | }

Kind: static constant of hebrewCodeUtil

hebrewCodeUtil.isConsonant ⇒ boolean

Is character c a Hebrew consonant? All consonants and diagraphs are included.

Kind: static constant of hebrewCodeUtil
Returns: boolean - true if c is Hebrew consonant

Param	Type	Description
c	string	input character

hebrewCodeUtil.isFinalConsonant ⇒ boolean

Is character c one of the 5 Hebrew final consonant?

Kind: static constant of hebrewCodeUtil
Returns: boolean - true if c is Hebrew final consonant

Param	Type	Description
c	string	input character

hebrewCodeUtil.hasFinalConsonant ⇒ boolean

Is character c one of the 5 Hebrew consonant that have final pairs?

Kind: static constant of hebrewCodeUtil
Returns: boolean - true if c is Hebrew consonant with final pair

Param	Type	Description
c	string	input character

hebrewCodeUtil.isVowel ⇒ boolean

Is character c a vowel? Shuruq may stand as diagraph too - context needed for that.

Kind: static constant of hebrewCodeUtil
Returns: boolean - true if c is a vowel

Param	Type	Description
c	string	input character

hebrewCodeUtil.isRegularDiacritic ⇒ boolean

Is character c a regular diacritic?

Kind: static constant of hebrewCodeUtil
Returns: boolean - true if c is a regular diacritic

Param	Type	Description
c	string	input character

hebrewCodeUtil.isCantillationDiacritic ⇒ boolean

Is character c a cantillation diacritic?

Kind: static constant of hebrewCodeUtil
Returns: boolean - true if c is a cantillation diacritic

Param	Type	Description
c	string	input character

hebrewCodeUtil.isDiacritic ⇒ boolean

Is character c a diacritic.

Kind: static constant of hebrewCodeUtil
Returns: boolean - true if c is a diacritic

Param	Type	Description
c	string	input character

hebrewCodeUtil.isPunctuation ⇒ boolean

Is character c a punctuation character.

Kind: static constant of hebrewCodeUtil
Returns: boolean - true if c is punctuation

Param	Type	Description
c	string	input character

hebrewCodeUtil.isDotting ⇒ boolean

Returns true if c is dotting character

Kind: static constant of hebrewCodeUtil
Returns: boolean - true if c is dotting

Param	Type	Description
c	string	input character

hebrewCodeUtil.isDotted ⇒ boolean

Return true if input word has vowels or diacritics

Kind: static constant of hebrewCodeUtil
Returns: boolean - true if word has vowels or diacritics

Param	Type	Description
word	string	input Hebrew unicode word

hebrewCodeUtil.isBegadkepat ⇒ boolean

Returns true if c is begadkepat character

Kind: static constant of hebrewCodeUtil
Returns: boolean - true if c is begadkepat

Param	Type	Description
c	string	input character

hebrewCodeUtil.removeDotting ⇒ string

Remove dotting (vowels and diacritics), leaving consonantal word only.

Kind: static constant of hebrewCodeUtil
Returns: string - consonantal word

Param	Type	Description
word	string	input word to be processed

hebrewCodeUtil.endify ⇒ string

Fix end consonant for a Hebrew word

Kind: static constant of hebrewCodeUtil
Returns: string - word with end consonant corrected

Param	Type	Description
word	string	input word

hebrewCodeUtil.sort ⇒ number

Comparator function to be used for sorting words

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