UNPKG

cal-phonetic

Version:

CAL code to Latin phonetic transliteration

github.com/peshitta/cal-phonetic

peshitta/cal-phonetic

89 lines (62 loc) • 3.62 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
# cal-phonetic [![npm version](https://badge.fury.io/js/cal-phonetic.svg)](https://badge.fury.io/js/cal-phonetic) [![npm module downloads](http://img.shields.io/npm/dt/cal-phonetic.svg)](https://www.npmjs.org/package/cal-phonetic) [![Build Status](https://travis-ci.org/peshitta/cal-phonetic.svg?branch=master)](https://travis-ci.org/peshitta/cal-phonetic) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/peshitta/cal-phonetic/blob/master/LICENSE) [![Dependency Status](https://david-dm.org/peshitta/cal-phonetic.svg)](https://david-dm.org/peshitta/cal-phonetic) [![Coverage Status](https://coveralls.io/repos/github/peshitta/cal-phonetic/badge.svg?branch=master)](https://coveralls.io/github/peshitta/cal-phonetic?branch=master) [![Gitter](https://badges.gitter.im/peshitta/peshitta.svg "Join the chat at https://gitter.im/peshitta/Lobby")](https://gitter.im/peshitta/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) CAL code to Latin phonetic transliteration ## Installation In order to use this library, [Node.js](https://nodejs.org) should be installed. Then run: ``` npm install cal-phonetic --save ``` Following bundles are available: * `cal-phonetic.js` - UMD ES5 version for use in browser, node, etc. * `cal-phonetic.min.js` - minified version of `cal-phonetic.js` * `cal-phonetic.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/cal-phonetic/-/cal-phonetic-1.0.3.tgz](https://registry.npmjs.org/cal-phonetic/-/cal-phonetic-1.0.3.tgz) ## More information [Peshitta App](https://peshitta.github.io) [Beth Mardutho](https://sedra.bethmardutho.org/about/fonts) [CAL](http://cal1.cn.huc.edu/searching/fullbrowser.html) ## License [MIT](https://github.com/peshitta/cal-phonetic/blob/master/LICENSE) ## Contributing The final goal for this work is to learn the Word of God as recorded by [Peshitta](https://en.wikipedia.org/wiki/Peshitta). You are welcomed to improve this implementation or provide feedback. Please feel free to [Fork](https://help.github.com/articles/fork-a-repo/), create a [Pull Request](https://help.github.com/articles/about-pull-requests/) or submit [Issues](https://github.com/peshitta/cal-phonetic/issues). To read quick updates about Peshitta app or post questions or feedback, follow [@peshittap](https://www.twitter.com/peshittap) at [![@peshittap](http://i.imgur.com/wWzX9uB.png "@peshittap")](https://www.twitter.com/peshittap)or [![Gitter](https://badges.gitter.im/peshitta/peshitta.svg "Join the chat at https://gitter.im/peshitta/Lobby")](https://gitter.im/peshitta/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) ## Development ``` npm install ``` ``` npm run build ``` ## API Reference * [calPhonetic](#module_calPhonetic) * [.mapper](#module_calPhonetic.mapper) : <code>Mapper</code> * [.toPhonetic](#module_calPhonetic.toPhonetic) ⇒ <code>string</code> <a name="module_calPhonetic.mapper"></a> ### calPhonetic.mapper : <code>Mapper</code> Phonetic Mapper **Kind**: static constant of [<code>calPhonetic</code>](#module_calPhonetic) <a name="module_calPhonetic.toPhonetic"></a> ### calPhonetic.toPhonetic ⇒ <code>string</code> Convert from CAL to Phonetic Latin **Kind**: static constant of [<code>calPhonetic</code>](#module_calPhonetic) **Returns**: <code>string</code> - the input word converted to phonetic Latin | Param | Type | Description | | --- | --- | --- | | word | <code>string</code> | input word in CAL code transliteration |