node package manager
Don’t reinvent the wheel. Reuse code within your team. Create a free org »

estrangela-code-util

estrangela-code-util

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

Estrangela ASCII code font utilities

Installation

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

npm install estrangela-code-util --save

Following bundles are available:

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

More information

Peshitta App

Estrangela Font Encoding Chart

Estrangela ASCII font

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 @peshittapor Gitter

Development

npm install
npm run build

API Reference

estrangelaCodeUtil.consonantsByName : Object.<string, string>

Estrangela consonant name to value map

Kind: static constant of estrangelaCodeUtil

estrangelaCodeUtil.baseConsonants : Array.<string>

Estrangela base consonants - the 22 aramaic consonants

Kind: static constant of estrangelaCodeUtil

estrangelaCodeUtil.finalConnected : Array.<string>

Estrangela final connected modified consonants

Kind: static constant of estrangelaCodeUtil

estrangelaCodeUtil.finalNonConnected : Array.<string>

Estrangela final non-connected modified consonants

Kind: static constant of estrangelaCodeUtil

estrangelaCodeUtil.ligatures : Array.<string>

Estrangela 2 ligatures

Kind: static constant of estrangelaCodeUtil

estrangelaCodeUtil.allConsonants : Array.<string>

All Estrangela font consonants

Kind: static constant of estrangelaCodeUtil

estrangelaCodeUtil.unconnected : Array.<string>

Estrangela consonants unconnected on the left

Kind: static constant of estrangelaCodeUtil

estrangelaCodeUtil.vowelsByName : Object.<string, string>

Estrangela vowel name to value map

Kind: static constant of estrangelaCodeUtil

estrangelaCodeUtil.commonVowels : Array.<string>

Estrangela common vowels - common to both eastern and western

Kind: static constant of estrangelaCodeUtil

estrangelaCodeUtil.easternVowels : Array.<string>

Estrangela eastern only vowels

Kind: static constant of estrangelaCodeUtil

estrangelaCodeUtil.shiftedVowels : Array.<string>

Estrangela shifted vowels (SHIFT key on)

Kind: static constant of estrangelaCodeUtil

estrangelaCodeUtil.baseVowels : Array.<string>

Estrangela vowels (both common and eastern) - excluding shifted

Kind: static constant of estrangelaCodeUtil

estrangelaCodeUtil.allVowels : Array.<string>

All Estrangela vowels (including shifted)

Kind: static constant of estrangelaCodeUtil

estrangelaCodeUtil.diacriticsByName : Object.<string, string>

Sedra/CAL diacritic name map

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

Kind: static constant of estrangelaCodeUtil

estrangelaCodeUtil.commonDiacritics : Array.<string>

Estrangela base/common diacritics (both western and eastern)

Kind: static constant of estrangelaCodeUtil

estrangelaCodeUtil.easternDiacritics : Array.<string>

Estrangela eastern specific diacritics

Kind: static constant of estrangelaCodeUtil

estrangelaCodeUtil.baseDiacritics : Array.<string>

Estrangela diacritics - excluding shifted

Kind: static constant of estrangelaCodeUtil

estrangelaCodeUtil.shiftedDiacritics : Array.<string>

Estrangela shifted diacritics

Kind: static constant of estrangelaCodeUtil

estrangelaCodeUtil.allDiacritics : Array.<string>

All Estrangela diacritics (including shifted)

Kind: static constant of estrangelaCodeUtil

estrangelaCodeUtil.punctuation : Array.<string>

Estrangela punctuation

Kind: static constant of estrangelaCodeUtil

estrangelaCodeUtil.joiners : Array.<string>

Estrangela joiners

Kind: static constant of estrangelaCodeUtil

estrangelaCodeUtil.letterAsciiMap : Object.<string, string>

Estrangela 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 estrangelaCodeUtil

estrangelaCodeUtil.dotting : Array.<string>

Vowels and diacritics: used for consonantal only mapping

Kind: static constant of estrangelaCodeUtil

estrangelaCodeUtil.isConsonant ⇒ boolean

Is character c an Estrangela consonant

Kind: static constant of estrangelaCodeUtil
Returns: boolean - true if c is Estrangela consonant

Param Type Description
c string input character

estrangelaCodeUtil.isVowel ⇒ boolean

Is character c an Estrangela vowel

Kind: static constant of estrangelaCodeUtil
Returns: boolean - true if c is Estrangela vowel

Param Type Description
c string input character

estrangelaCodeUtil.isDiacritic ⇒ boolean

Is character c an Estrangela diacritic

Kind: static constant of estrangelaCodeUtil
Returns: boolean - true if c is Estrangela diacritic

Param Type Description
c string input character

estrangelaCodeUtil.isPunctuation ⇒ boolean

Is character c an Estrangela punctuation

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

Param Type Description
c string input character

estrangelaCodeUtil.isJoiner ⇒ boolean

Is character c an Estrangela joiner

Kind: static constant of estrangelaCodeUtil
Returns: boolean - true if c is Estrangela joiner

Param Type Description
c string input character

estrangelaCodeUtil.isEasternDiacritic ⇒ boolean

Is character c an Estrangela Eastern Diacritic

Kind: static constant of estrangelaCodeUtil
Returns: boolean - true if c is Estrangela Eastern Diacritic

Param Type Description
c string input character

estrangelaCodeUtil.isUnconnected ⇒ boolean

Is character c an unconnected on the left Estrangela consonant

Kind: static constant of estrangelaCodeUtil
Returns: boolean - true if c is unconnected on the left consonant

Param Type Description
c string input character

estrangelaCodeUtil.isDotting ⇒ boolean

Returns true if c is dotting character

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

Param Type Description
c string input character

estrangelaCodeUtil.endify ⇒ string

Fix end consonant for a word in base Estrangela font

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

Param Type Description
word string input word

estrangelaCodeUtil.isDotted ⇒ boolean

Return true if input word has vowels or diacritics

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

Param Type Description
word string input word

estrangelaCodeUtil.removeDotting ⇒ string

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

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

Param Type Description
word string input word to be processed

estrangelaCodeUtil.sort ⇒ number

Comparator function to be used for sorting Estrangela words

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

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