ipa-code-util

IPA Unicode utilities

Installation

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

npm install ipa-code-util --save

Following bundles are available:

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

More information

Peshitta App

IPA

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

• ipaCodeUtil
  • .consonantsByName : Object.<string, string>
  • .consonants : Array.<string>
  • .begadkepatConsonants : Array.<string>
  • .veghadhkhefathConsonants : Array.<string>
  • .begadkepatMap : Object.<string, string>
  • .extraConsonants : Array.<string>
  • .allConsonants : Array.<string>
  • .vowelsByName : Object.<string, string>
  • .commonVowels : Array.<string>
  • .easternVowels : Array.<string>
  • .otherVowels : Array.<string>
  • .allVowels : Array.<string>
  • .silent : string
  • .isConsonant ⇒ boolean
  • .isVowel ⇒ boolean
  • .isDotted ⇒ boolean
  • .removeVowels ⇒ string
  • .isBegadkepat ⇒ boolean
  • .isVeghadhkhefath ⇒ boolean

ipaCodeUtil.consonantsByName : Object.<string, string>

IPA consonant name to value map

Kind: static constant of ipaCodeUtil

ipaCodeUtil.consonants : Array.<string>

Semitic 22 base consonants

Kind: static constant of ipaCodeUtil

ipaCodeUtil.begadkepatConsonants : Array.<string>

Begadkepat consonants

Kind: static constant of ipaCodeUtil

ipaCodeUtil.veghadhkhefathConsonants : Array.<string>

Veghadhkhefath consonants

Kind: static constant of ipaCodeUtil

ipaCodeUtil.begadkepatMap : Object.<string, string>

Begadkepat to veghadhkhefath map

Kind: static constant of ipaCodeUtil

ipaCodeUtil.extraConsonants : Array.<string>

Other semitic consonants

Kind: static constant of ipaCodeUtil

ipaCodeUtil.allConsonants : Array.<string>

All consonants concatenated

Kind: static constant of ipaCodeUtil

ipaCodeUtil.vowelsByName : Object.<string, string>

IPA vowel name to value map

Kind: static constant of ipaCodeUtil

ipaCodeUtil.commonVowels : Array.<string>

Common aramaic vowels

Kind: static constant of ipaCodeUtil

ipaCodeUtil.easternVowels : Array.<string>

Eastern/hebrew only vowels

Kind: static constant of ipaCodeUtil

ipaCodeUtil.otherVowels : Array.<string>

Other semitic vowels

Kind: static constant of ipaCodeUtil

ipaCodeUtil.allVowels : Array.<string>

Semitic vowels including Eastern/Hebrew ones and other short vowels.

Kind: static constant of ipaCodeUtil

ipaCodeUtil.silent : string

The silent letter symbol

Kind: static constant of ipaCodeUtil

ipaCodeUtil.isConsonant ⇒ boolean

Is character c a semitic consonant

Kind: static constant of ipaCodeUtil
Returns: boolean - true if c is semitic consonant

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

ipaCodeUtil.isVowel ⇒ boolean

Is character c a semitic vowel

Kind: static constant of ipaCodeUtil
Returns: boolean - true if c is semitic vowel

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

ipaCodeUtil.isDotted ⇒ boolean

Return true if input word has vowels or diacritics

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

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

ipaCodeUtil.removeVowels ⇒ string

Remove vowels, leaving consonantal word only.

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

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

ipaCodeUtil.isBegadkepat ⇒ boolean

Returns true if c is a begadkepat consonant

Kind: static constant of ipaCodeUtil
Returns: boolean - true if c is a begadkepat consonant

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

ipaCodeUtil.isVeghadhkhefath ⇒ boolean

Returns true if c is a veghadhkhefath consonant

Kind: static constant of ipaCodeUtil
Returns: boolean - true if c is a veghadhkhefath consonant

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