syriac-code-util

Syriac Unicode utilities

Installation

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

npm install syriac-code-util --save

Following bundles are available:

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

• syriacCodeUtil
  • .consonantsByName : Object.<string, string>
  • .consonants : Array.<string>
  • .extraConsonants : Array.<string>
  • .allConsonants : Array.<string>
  • .punctuation : Array.<string>
  • .easternVowelsByName : Object.<string, string>
  • .easternCommonVowels : Array.<string>
  • .easternOnlyVowels : Array.<string>
  • .easternVowels : Array.<string>
  • .westernVowelsByName : Object.<string, string>
  • .westernVowels : Array.<string>
  • .westernVowelsBellow : Array.<string>
  • .allWesternVowels : Array.<string>
  • .garshuniVowels : Array.<string>
  • .allVowels : Array.<string>
  • .diacriticsByName : Object.<string, string>
  • .commonDiacritics : Array.<string>
  • .swadayaDiacritics : Array.<string>
  • .otherDiacritics : Array.<string>
  • .allDiacritics : Array.<string>
  • .other : Array.<string>
  • .dotting : Array.<string>
  • .letterAsciiMap : Object.<string, string>
  • .isConsonant ⇒ boolean
  • .isEasternVowel ⇒ boolean
  • .isWesternVowel ⇒ boolean
  • .isVowel ⇒ boolean
  • .isCommonDiacritic ⇒ boolean
  • .isSwadayaDiacritic ⇒ boolean
  • .isOtherDiacritic ⇒ boolean
  • .isDiacritic ⇒ boolean
  • .isPunctuation ⇒ boolean
  • .isOther ⇒ boolean
  • .isDotting ⇒ boolean
  • .isDotted ⇒ boolean
  • .removeDotting ⇒ string
  • .sort ⇒ number

syriacCodeUtil.consonantsByName : Object.<string, string>

CAL consonant name to value map

Kind: static constant of syriacCodeUtil

syriacCodeUtil.consonants : Array.<string>

Syriac base 22 consonants

Kind: static constant of syriacCodeUtil

syriacCodeUtil.extraConsonants : Array.<string>

Syriac extra consonants: Garshuni, ancient, Persian, Sogdian, Palestinian, etc.

Kind: static constant of syriacCodeUtil

syriacCodeUtil.allConsonants : Array.<string>

All Syriac consonants including Garshuni, Persian, Sogdian and Palestinian, etc.

Kind: static constant of syriacCodeUtil

syriacCodeUtil.punctuation : Array.<string>

Syriac punctuation

Kind: static constant of syriacCodeUtil

syriacCodeUtil.easternVowelsByName : Object.<string, string>

Eastern vowel name to value map

Kind: static constant of syriacCodeUtil

syriacCodeUtil.easternCommonVowels : Array.<string>

Eastern common vowels - common to Western Syriac as well

Kind: static constant of syriacCodeUtil

syriacCodeUtil.easternOnlyVowels : Array.<string>

Eastern only vowels

Kind: static constant of syriacCodeUtil

syriacCodeUtil.easternVowels : Array.<string>

Eastern vowels

Kind: static constant of syriacCodeUtil

syriacCodeUtil.westernVowelsByName : Object.<string, string>

Western vowel name to value map

Kind: static constant of syriacCodeUtil

syriacCodeUtil.westernVowels : Array.<string>

Western vowels

Kind: static constant of syriacCodeUtil

syriacCodeUtil.westernVowelsBellow : Array.<string>

Western vowels below line

Kind: static constant of syriacCodeUtil

syriacCodeUtil.allWesternVowels : Array.<string>

All Western vowels

Kind: static constant of syriacCodeUtil

syriacCodeUtil.garshuniVowels : Array.<string>

Garshuni vowels

Kind: static constant of syriacCodeUtil

syriacCodeUtil.allVowels : Array.<string>

Eastern/Western and Garshuni vowels

Kind: static constant of syriacCodeUtil

syriacCodeUtil.diacriticsByName : Object.<string, string>

Diacritics name map

Kind: static constant of syriacCodeUtil

syriacCodeUtil.commonDiacritics : Array.<string>

Diacritics common to both Eastern and Western Qushaya, Rukkakha, Line under, Seyame

Kind: static constant of syriacCodeUtil

syriacCodeUtil.swadayaDiacritics : Array.<string>

Swadaya Eastern diacritics

Kind: static constant of syriacCodeUtil

syriacCodeUtil.otherDiacritics : Array.<string>

Other diacritics: Qushaya, Rukkakha, Line variations, etc.

Kind: static constant of syriacCodeUtil

syriacCodeUtil.allDiacritics : Array.<string>

Eastern and Western diacritics

Kind: static constant of syriacCodeUtil

syriacCodeUtil.other : Array.<string>

Other symbols

Kind: static constant of syriacCodeUtil

syriacCodeUtil.dotting : Array.<string>

Vowels and diacritics: used for consonantal only mapping

Kind: static constant of syriacCodeUtil

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

syriacCodeUtil.isConsonant ⇒ boolean

Is character c a Syriac consonant? All Eastern and Western and Garshuni, etc.

Kind: static constant of syriacCodeUtil
Returns: boolean - true if c is Syriac consonant

| Param | Type | Description | | --- | --- | --- | | c | string | input character |

syriacCodeUtil.isEasternVowel ⇒ boolean

Is character c a Eastern vowel?

Kind: static constant of syriacCodeUtil
Returns: boolean - true if c is Eastern vowel

| Param | Type | Description | | --- | --- | --- | | c | string | input character |

syriacCodeUtil.isWesternVowel ⇒ boolean

Is character c a Western vowel?

Kind: static constant of syriacCodeUtil
Returns: boolean - true if c is Western vowel

| Param | Type | Description | | --- | --- | --- | | c | string | input character |

syriacCodeUtil.isVowel ⇒ boolean

Is character c a vowel? Includes both Eastern and Western.

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

| Param | Type | Description | | --- | --- | --- | | c | string | input character |

syriacCodeUtil.isCommonDiacritic ⇒ boolean

Is character c a diacritic common to both Eastern and Western.

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

| Param | Type | Description | | --- | --- | --- | | c | string | input character |

syriacCodeUtil.isSwadayaDiacritic ⇒ boolean

Is character c a Swadaya Eastern diacritic

Kind: static constant of syriacCodeUtil
Returns: boolean - true if c is a Swadaya Eastern diacritic

| Param | Type | Description | | --- | --- | --- | | c | string | input character |

syriacCodeUtil.isOtherDiacritic ⇒ boolean

Is character c other diacritic: common diacritic variations, Western or Turoyo variations, etc.

Kind: static constant of syriacCodeUtil
Returns: boolean - true if c is other type of diacritic

| Param | Type | Description | | --- | --- | --- | | c | string | input character |

syriacCodeUtil.isDiacritic ⇒ boolean

Is character c a diacritic.

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

| Param | Type | Description | | --- | --- | --- | | c | string | input character |

syriacCodeUtil.isPunctuation ⇒ boolean

Is character c a punctuation character.

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

| Param | Type | Description | | --- | --- | --- | | c | string | input character |

syriacCodeUtil.isOther ⇒ boolean

Returns true if c is other character

Kind: static constant of syriacCodeUtil
Returns: boolean - true if c is other character

| Param | Type | Description | | --- | --- | --- | | c | string | input character |

syriacCodeUtil.isDotting ⇒ boolean

Returns true if c is dotting character

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

| Param | Type | Description | | --- | --- | --- | | c | string | input character |

syriacCodeUtil.isDotted ⇒ boolean

Return true if input word has vowels or diacritics

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

| Param | Type | Description | | --- | --- | --- | | word | string | input word |

syriacCodeUtil.removeDotting ⇒ string

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

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

| Param | Type | Description | | --- | --- | --- | | word | string | input word to be processed |

syriacCodeUtil.sort ⇒ number

Comparator function to be used for sorting CAL words

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

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