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 ofipa-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
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
- 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
- .consonantsByName :
Object.<string, string>
ipaCodeUtil.consonantsByName : IPA consonant name to value map
Kind: static constant of ipaCodeUtil
Array.<string>
ipaCodeUtil.consonants : Semitic 22 base consonants
Kind: static constant of ipaCodeUtil
Array.<string>
ipaCodeUtil.begadkepatConsonants : Begadkepat consonants
Kind: static constant of ipaCodeUtil
Array.<string>
ipaCodeUtil.veghadhkhefathConsonants : Veghadhkhefath consonants
Kind: static constant of ipaCodeUtil
Object.<string, string>
ipaCodeUtil.begadkepatMap : Begadkepat to veghadhkhefath map
Kind: static constant of ipaCodeUtil
Array.<string>
ipaCodeUtil.extraConsonants : Other semitic consonants
Kind: static constant of ipaCodeUtil
Array.<string>
ipaCodeUtil.allConsonants : All consonants concatenated
Kind: static constant of ipaCodeUtil
Object.<string, string>
ipaCodeUtil.vowelsByName : IPA vowel name to value map
Kind: static constant of ipaCodeUtil
Array.<string>
ipaCodeUtil.commonVowels : Common aramaic vowels
Kind: static constant of ipaCodeUtil
Array.<string>
ipaCodeUtil.easternVowels : Eastern/hebrew only vowels
Kind: static constant of ipaCodeUtil
Array.<string>
ipaCodeUtil.otherVowels : Other semitic vowels
Kind: static constant of ipaCodeUtil
Array.<string>
ipaCodeUtil.allVowels : Semitic vowels including Eastern/Hebrew ones and other short vowels.
Kind: static constant of ipaCodeUtil
string
ipaCodeUtil.silent : The silent letter symbol
Kind: static constant of ipaCodeUtil
boolean
ipaCodeUtil.isConsonant ⇒ 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 |
boolean
ipaCodeUtil.isVowel ⇒ 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 |
boolean
ipaCodeUtil.isDotted ⇒ 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 |
string
ipaCodeUtil.removeVowels ⇒ 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 |
boolean
ipaCodeUtil.isBegadkepat ⇒ 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 |
boolean
ipaCodeUtil.isVeghadhkhefath ⇒ 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 |