node package manager
Stop writing boring code. Discover, share, and reuse within your team. Create a free org »

cal-code-util

cal-code-util

npm version npm module downloads Build Status License: MIT Dependency Status Coverage Status Gitter

Aramaic CAL code transliteration utilities

Installation

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

npm install cal-code-util --save

Following bundles are available:

  • cal-code-util.js - UMD ES5 version for use in browser, node, etc.
  • cal-code-util.min.js - minified version of cal-code-util.js
  • cal-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/cal-code-util/-/cal-code-util-1.1.3.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 the app or post questions or feedback, follow @peshittap at @peshittapor Gitter

Development

npm install
npm run build

API Reference

calCodeUtil.consonantsByName : Object.<string, string>

CAL consonant name to value map

Kind: static constant of calCodeUtil

calCodeUtil.consonants : Array.<string>

CAL consonants

Kind: static constant of calCodeUtil

calCodeUtil.extraConsonants : Array.<string>

Extra CAL consonants specific to Palestinian or Hebrew

Kind: static constant of calCodeUtil

calCodeUtil.allConsonants : Array.<string>

Base consonants + extra consonants

Kind: static constant of calCodeUtil

calCodeUtil.vowelsByName : Object.<string, string>

CAL vowel name to value map

Kind: static constant of calCodeUtil

calCodeUtil.commonVowels : Array.<string>

CAL common vowels

Kind: static constant of calCodeUtil

calCodeUtil.easternVowels : Array.<string>

CAL eastern/hebrew only vowels

Kind: static constant of calCodeUtil

calCodeUtil.vowels : Array.<string>

CAL vowels including Eastern/Hebrew ones

Kind: static constant of calCodeUtil

calCodeUtil.diacriticsByName : Object.<string, string>

Sedra/CAL diacritic name map

  1. qushaya: ' - dot above
  2. rukkakha: , - dot below
  3. lineaOccultans: _ - linea occultans
  4. seyame: * - seyame, rebwe

Kind: static constant of calCodeUtil

calCodeUtil.diacritics : Array.<string>

Sedra/CAL diacritic characters:

  1. ' dot above, Qushaya
  2. , dot below, Rukkakha
  3. _ line under
  4. * Seyame

Kind: static constant of calCodeUtil

calCodeUtil.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 calCodeUtil

calCodeUtil.punctuation : Array.<string>

Common punctuation

Kind: static constant of calCodeUtil

calCodeUtil.dotting : Array.<string>

Vowels and diacritics: used for consonantal only mapping

Kind: static constant of calCodeUtil

calCodeUtil.isConsonant ⇒ boolean

Is character c a CAL consonant

Kind: static constant of calCodeUtil
Returns: boolean - true if c is CAL consonant

Param Type Description
c string input character

calCodeUtil.isVowel ⇒ boolean

Is character c a CAL vowel

Kind: static constant of calCodeUtil
Returns: boolean - true if c is CAL vowel

Param Type Description
c string input character

calCodeUtil.isDiacritic ⇒ boolean

Is character c a diacritic? Same characters used for both Sedra 3 and CAL.

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

Param Type Description
c string input character

calCodeUtil.isPunctuation ⇒ boolean

Is character c a common punctuation char?

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

Param Type Description
c string input character

calCodeUtil.isDotting ⇒ boolean

Returns true if c is dotting character

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

Param Type Description
c string input character

calCodeUtil.isDotted ⇒ boolean

Return true if input word has vowels or diacritics

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

Param Type Description
word string input CAL code word

calCodeUtil.removeDotting ⇒ string

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

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

Param Type Description
word string input word to be processed

calCodeUtil.sort ⇒ number

Comparator function to be used for sorting CAL words

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

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