sedra-code-util
Sedra 3 ASCII code transliteration utilities
Installation
In order to use this library, Node.js should be installed. Then run:
npm install sedra-code-util --save
Following bundles are available:
-
sedra-code-util.js
- UMD ES5 version for use in browser, node, etc. -
sedra-code-util.min.js
- minified version ofsedra-code-util.js
-
sedra-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/sedra-code-util/-/sedra-code-util-1.0.8.tgz
More information
License
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
-
sedraCodeUtil
-
.consonantsByName :
Object.<string, string>
-
.consonants :
Array.<string>
-
.vowelsByName :
Object.<string, string>
-
.vowels :
Array.<string>
-
.diacriticsByName :
Object.<string, string>
-
.diacritics :
Array.<string>
-
.letterAsciiMap :
Object.<string, string>
-
.dotting :
Array.<string>
-
.isConsonant ⇒
boolean
-
.isVowel ⇒
boolean
-
.isDiacritic ⇒
boolean
-
.isDotting ⇒
boolean
-
.isDotted ⇒
boolean
-
.removeDotting ⇒
string
-
.sort ⇒
number
-
.consonantsByName :
Object.<string, string>
sedraCodeUtil.consonantsByName : Sedra consonant name to value map
Kind: static constant of sedraCodeUtil
Array.<string>
sedraCodeUtil.consonants : Sedra consonants
Kind: static constant of sedraCodeUtil
Object.<string, string>
sedraCodeUtil.vowelsByName : Sedra vowel name to value map
Kind: static constant of sedraCodeUtil
Array.<string>
sedraCodeUtil.vowels : Sedra vowels
Kind: static constant of sedraCodeUtil
Object.<string, string>
sedraCodeUtil.diacriticsByName : Sedra/CAL diacritic name map
- qushaya: ' - dot above
- rukkakha: , - dot below
- lineaOccultans: _ - linea occultans
- seyame: * - seyame, rebwe
Kind: static constant of sedraCodeUtil
Array.<string>
sedraCodeUtil.diacritics : Sedra/CAL diacritic characters:
- ' dot above, Qushaya
- , dot below, Rukkakha
- _ line under
- * Seyame
Kind: static constant of sedraCodeUtil
Object.<string, string>
sedraCodeUtil.letterAsciiMap : 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 sedraCodeUtil
Array.<string>
sedraCodeUtil.dotting : Vowels and diacritics: used for consonantal only mapping
Kind: static constant of sedraCodeUtil
boolean
sedraCodeUtil.isConsonant ⇒ Is character c a Sedra 3 consonant?
Kind: static constant of sedraCodeUtil
Returns: boolean
- true if c is Sedra 3 consonant
Param | Type | Description |
---|---|---|
c | string |
input character |
boolean
sedraCodeUtil.isVowel ⇒ Is character c a Sedra 3 vowel?
Kind: static constant of sedraCodeUtil
Returns: boolean
- true if c is Sedra 3 vowel
Param | Type | Description |
---|---|---|
c | string |
input character |
boolean
sedraCodeUtil.isDiacritic ⇒ Is character c a diacritic? Same characters used for both Sedra 3 and CAL.
Kind: static constant of sedraCodeUtil
Returns: boolean
- true if c is a diacritic
Param | Type | Description |
---|---|---|
c | string |
input character |
boolean
sedraCodeUtil.isDotting ⇒ Returns true if c is dotting character
Kind: static constant of sedraCodeUtil
Returns: boolean
- true if c is dotting
Param | Type | Description |
---|---|---|
c | string |
input character |
boolean
sedraCodeUtil.isDotted ⇒ Return true if input word has vowels or diacritics
Kind: static constant of sedraCodeUtil
Returns: boolean
- true if word has vowels or diacritics
Param | Type | Description |
---|---|---|
word | string |
input CAL code word |
string
sedraCodeUtil.removeDotting ⇒ Remove dotting (vowels and diacritics), leaving consonantal word only.
Kind: static constant of sedraCodeUtil
Returns: string
- consonantal word
Param | Type | Description |
---|---|---|
word | string |
input word to be processed |
number
sedraCodeUtil.sort ⇒ Comparator function to be used for sorting words
Kind: static constant of sedraCodeUtil
Returns: number
- -1, 0, 1 depending on word sorting
Param | Type | Description |
---|---|---|
word1 | string |
first word to compare |
word2 | string |
second word to compare |