arabic-code-util

Arabic Unicode utilities - handling only Garshuni subset

Installation

In order to use this library, Node.js should be installed. Then run:

npm install arabic-code-util --save

Following bundles are available:

• arabic-code-util.js - UMD ES5 version for use in browser, node, etc.
• arabic-code-util.min.js - minified version of arabic-code-util.js
• arabic-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/arabic-code-util/-/arabic-code-util-1.0.8.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

• arabicCodeUtil
  • .consonantsByName : Object.<string, string>
  • .consonants : Array.<string>
  • .extraConsonants : Array.<string>
  • .allConsonants : Array.<string>
  • .vowelsByName : Object.<string, string>
  • .vowels : Array.<string>
  • .diacriticsByName : Object.<string, string>
  • .diacritics : Array.<string>
  • .punctuation : Array.<string>
  • .letterAsciiMap : Object.<string, string>
  • .dotting : Array.<string>
  • .isConsonant ⇒ boolean
  • .isVowel ⇒ boolean
  • .isDiacritic ⇒ boolean
  • .isPunctuation ⇒ boolean
  • .isDotting ⇒ boolean
  • .isDotted ⇒ boolean
  • .removeDotting ⇒ string
  • .sort ⇒ number

arabicCodeUtil.consonantsByName : Object.<string, string>

Arabic consonants by name

Kind: static constant of arabicCodeUtil

arabicCodeUtil.consonants : Array.<string>

Arabic base 22 consonants common to other semitic languages

Kind: static constant of arabicCodeUtil

arabicCodeUtil.extraConsonants : Array.<string>

Garshuni extras

Kind: static constant of arabicCodeUtil

arabicCodeUtil.allConsonants : Array.<string>

All Arabic consonants relevant to Syriac including Garshuni

Kind: static constant of arabicCodeUtil

arabicCodeUtil.vowelsByName : Object.<string, string>

Arabic/Garshuni vowels by name

Kind: static constant of arabicCodeUtil

arabicCodeUtil.vowels : Array.<string>

Arabic/Garshuni vowels

Kind: static constant of arabicCodeUtil

arabicCodeUtil.diacriticsByName : Object.<string, string>

Arabic/Garshuni diacritics by name

Kind: static constant of arabicCodeUtil

arabicCodeUtil.diacritics : Array.<string>

Arabic/Garshuni diacritics

Kind: static constant of arabicCodeUtil

arabicCodeUtil.punctuation : Array.<string>

Arabic punctuation relevant to Syriac

Kind: static constant of arabicCodeUtil

arabicCodeUtil.letterAsciiMap : Object.<string, string>

CAL 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 arabicCodeUtil

arabicCodeUtil.dotting : Array.<string>

Vowels and diacritics: used for consonantal only mapping

Kind: static constant of arabicCodeUtil

arabicCodeUtil.isConsonant ⇒ boolean

Is character c an Arabic consonant? Only Syriac relevant are considered.

Kind: static constant of arabicCodeUtil
Returns: boolean - true if c is Arabic consonant

Param	Type	Description
c	string	input character

arabicCodeUtil.isVowel ⇒ boolean

Is character c a vowel?

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

Param	Type	Description
c	string	input character

arabicCodeUtil.isDiacritic ⇒ boolean

Is character c a diacritic.

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

Param	Type	Description
c	string	input character

arabicCodeUtil.isPunctuation ⇒ boolean

Is character c a punctuation character.

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

Param	Type	Description
c	string	input character

arabicCodeUtil.isDotting ⇒ boolean

Returns true if c is dotting character

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

Param	Type	Description
c	string	input character

arabicCodeUtil.isDotted ⇒ boolean

Return true if input word has vowels or diacritics

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

Param	Type	Description
word	string	input Arabic Unicode word

arabicCodeUtil.removeDotting ⇒ string

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

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

Param	Type	Description
word	string	input word to be processed

arabicCodeUtil.sort ⇒ number

Comparator function to be used for sorting words

Kind: static constant of arabicCodeUtil
Returns: number - -1, 0, 1 depending on word sorting

Param	Type	Description
word1	string	first word to compare
word2	string	second word to compare