npm

Does your artifact manager get in the way? Join us on Oct. 8 at 10am PT, to discuss how npm can help.Sign up »

sedra-code-util

1.0.8 • Public • Published

sedra-code-util

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

Sedra 3 ASCII code transliteration utilities

Installation

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

npm install sedra-code-util --save

Following bundles are available:

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

sedraCodeUtil.consonantsByName : Object.<string, string>

Sedra consonant name to value map

Kind: static constant of sedraCodeUtil

sedraCodeUtil.consonants : Array.<string>

Sedra consonants

Kind: static constant of sedraCodeUtil

sedraCodeUtil.vowelsByName : Object.<string, string>

Sedra vowel name to value map

Kind: static constant of sedraCodeUtil

sedraCodeUtil.vowels : Array.<string>

Sedra vowels

Kind: static constant of sedraCodeUtil

sedraCodeUtil.diacriticsByName : Object.<string, string>

Sedra/CAL diacritic name map

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

Kind: static constant of sedraCodeUtil

sedraCodeUtil.diacritics : Array.<string>

Sedra/CAL diacritic characters:

  • ' dot above, Qushaya
  • , dot below, Rukkakha
  • _ line under
  • * Seyame

Kind: static constant of sedraCodeUtil

sedraCodeUtil.letterAsciiMap : Object.<string, string>

CAL 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 sedraCodeUtil

sedraCodeUtil.dotting : Array.<string>

Vowels and diacritics: used for consonantal only mapping

Kind: static constant of sedraCodeUtil

sedraCodeUtil.isConsonant ⇒ boolean

Is character c a Sedra 3 consonant?

Kind: static constant of sedraCodeUtil
Returns: boolean - true if c is Sedra 3 consonant

Param Type Description
c string input character

sedraCodeUtil.isVowel ⇒ boolean

Is character c a Sedra 3 vowel?

Kind: static constant of sedraCodeUtil
Returns: boolean - true if c is Sedra 3 vowel

Param Type Description
c string input character

sedraCodeUtil.isDiacritic ⇒ boolean

Is character c a diacritic? Same characters used for both Sedra 3 and CAL.

Kind: static constant of sedraCodeUtil
Returns: boolean - true if c is a diacritic

Param Type Description
c string input character

sedraCodeUtil.isDotting ⇒ boolean

Returns true if c is dotting character

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

Param Type Description
c string input character

sedraCodeUtil.isDotted ⇒ boolean

Return true if input word has vowels or diacritics

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

Param Type Description
word string input CAL code word

sedraCodeUtil.removeDotting ⇒ string

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

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

Param Type Description
word string input word to be processed

sedraCodeUtil.sort ⇒ number

Comparator function to be used for sorting words

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

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

install

npm i sedra-code-util

Downloadsweekly downloads

8

version

1.0.8

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability