phonetic-code-util

    1.0.5 • Public • Published

    phonetic-code-util

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

    Semitic Latin phonetic transliteration utilities

    Installation

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

    npm install phonetic-code-util --save
    

    Following bundles are available:

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

    Development

    npm install
    
    npm run build
    

    API Reference

    phoneticCodeUtil.consonantsByName : Object.<string, string>

    Phonetic latin consonant name to value map

    Kind: static constant of phoneticCodeUtil

    phoneticCodeUtil.consonants : Array.<string>

    Semitic 22 base consonants

    Kind: static constant of phoneticCodeUtil

    phoneticCodeUtil.begadkepatConsonants : Array.<string>

    Begadkepat consonants

    Kind: static constant of phoneticCodeUtil

    phoneticCodeUtil.veghadhkhefathConsonants : Array.<string>

    Veghadhkhefath consonants

    Kind: static constant of phoneticCodeUtil

    phoneticCodeUtil.begadkepatMap : Object.<string, string>

    Begadkepat to veghadhkhefath map

    Kind: static constant of phoneticCodeUtil

    phoneticCodeUtil.extraConsonants : Array.<string>

    Other semitic consonants

    Kind: static constant of phoneticCodeUtil

    phoneticCodeUtil.allConsonants : Array.<string>

    All consonants concatenated

    Kind: static constant of phoneticCodeUtil

    phoneticCodeUtil.vowelsByName : Object.<string, string>

    Phonetic latin vowel name to value map

    Kind: static constant of phoneticCodeUtil

    phoneticCodeUtil.commonVowels : Array.<string>

    Common aramaic vowels

    Kind: static constant of phoneticCodeUtil

    phoneticCodeUtil.easternVowels : Array.<string>

    Eastern/hebrew only vowels

    Kind: static constant of phoneticCodeUtil

    phoneticCodeUtil.otherVowels : Array.<string>

    Other semitic vowels

    Kind: static constant of phoneticCodeUtil

    phoneticCodeUtil.allVowels : Array.<string>

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

    Kind: static constant of phoneticCodeUtil

    phoneticCodeUtil.silent : string

    The silent letter symbol

    Kind: static constant of phoneticCodeUtil

    phoneticCodeUtil.isConsonant ⇒ boolean

    Is character c a semitic consonant

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

    Param Type Description
    c string input character

    phoneticCodeUtil.isVowel ⇒ boolean

    Is character c a semitic vowel

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

    Param Type Description
    c string input character

    phoneticCodeUtil.isDotted ⇒ boolean

    Return true if input word has vowels

    Kind: static constant of phoneticCodeUtil
    Returns: boolean - true if word has vowels

    Param Type Description
    word string input word

    phoneticCodeUtil.removeVowels ⇒ string

    Remove vowels, leaving consonantal word only.

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

    Param Type Description
    word string input word to be processed

    phoneticCodeUtil.isBegadkepat ⇒ boolean

    Returns true if c is a begadkepat consonant

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

    Param Type Description
    c string input character

    phoneticCodeUtil.isVeghadhkhefath ⇒ boolean

    Returns true if c is a veghadhkhefath consonant

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

    Param Type Description
    c string input character

    Install

    npm i phonetic-code-util

    DownloadsWeekly Downloads

    0

    Version

    1.0.5

    License

    MIT

    Last publish

    Collaborators

    • avatar