estrangela-code-util


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.1.0.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 ![@peshittap](https://www.twitter.com/peshittap)or
![Gitter](https://gitter.im/peshitta/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)

Development

`
npm install
`
`
npm run build
``

API Reference

* estrangelaCodeUtil
* .consonantsByName : Object.<string, string>
* .baseConsonants : Array.<string>
* .finalConnected : Array.<string>
* .finalNonConnected : Array.<string>
* .ligatures : Array.<string>
* .allConsonants : Array.<string>
* .unconnected : Array.<string>
* .vowelsByName : Object.<string, string>
* .commonVowels : Array.<string>
* .easternVowels : Array.<string>
* .shiftedVowels : Array.<string>
* .baseVowels : Array.<string>
* .allVowels : Array.<string>
* .diacriticsByName : Object.<string, string>
* .commonDiacritics : Array.<string>
* .easternDiacritics : Array.<string>
* .baseDiacritics : Array.<string>
* .shiftedDiacritics : Array.<string>
* .allDiacritics : Array.<string>
* .punctuation : Array.<string>
* .joiners : Array.<string>
* .letterAsciiMap : Object.<string, string>
* .dotting : Array.<string>
* .isConsonant ⇒ boolean
* .isVowel ⇒ boolean
* .isDiacritic ⇒ boolean
* .isPunctuation ⇒ boolean
* .isJoiner ⇒ boolean
* .isEasternDiacritic ⇒ boolean
* .isUnconnected ⇒ boolean
* .isDotting ⇒ boolean
* .endify ⇒ string
* .isDotted ⇒ boolean
* .removeDotting ⇒ string
* .sort ⇒ number

$3

Estrangela consonant name to value map

Kind: static constant of estrangelaCodeUtil

$3

Estrangela base consonants - the 22 aramaic consonants

Kind: static constant of estrangelaCodeUtil

$3

Estrangela final connected modified consonants

Kind: static constant of estrangelaCodeUtil

$3

Estrangela final non-connected modified consonants

Kind: static constant of estrangelaCodeUtil

$3

Estrangela 2 ligatures

Kind: static constant of estrangelaCodeUtil

$3

All Estrangela font consonants

Kind: static constant of estrangelaCodeUtil

$3

Estrangela consonants unconnected on the left

Kind: static constant of estrangelaCodeUtil

$3

Estrangela vowel name to value map

Kind: static constant of estrangelaCodeUtil

$3

Estrangela common vowels - common to both eastern and western

Kind: static constant of estrangelaCodeUtil

$3

Estrangela eastern only vowels

Kind: static constant of estrangelaCodeUtil

$3

Estrangela shifted vowels (SHIFT key on)

Kind: static constant of estrangelaCodeUtil

$3

Estrangela vowels (both common and eastern) - excluding shifted

Kind: static constant of estrangelaCodeUtil

$3

All Estrangela vowels (including shifted)

Kind: static constant of estrangelaCodeUtil

$3

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

$3

Estrangela base/common diacritics (both western and eastern)

Kind: static constant of estrangelaCodeUtil

$3

Estrangela eastern specific diacritics

Kind: static constant of estrangelaCodeUtil

$3

Estrangela diacritics - excluding shifted

Kind: static constant of estrangelaCodeUtil

$3

Estrangela shifted diacritics

Kind: static constant of estrangelaCodeUtil

$3

All Estrangela diacritics (including shifted)

Kind: static constant of estrangelaCodeUtil

$3

Estrangela punctuation

Kind: static constant of estrangelaCodeUtil

$3

Estrangela joiners

Kind: static constant of estrangelaCodeUtil

$3

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

$3

Vowels and diacritics: used for consonantal only mapping

Kind: static constant of estrangelaCodeUtil

$3

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 |

$3

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 |

$3

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 |

$3

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 |

$3

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 |

$3

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 |

$3

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 |

$3

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 |

$3

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 |

$3

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 |

$3

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 |

$3

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 |