/anvaad-js

Transliteration toolkit for Gurmukhi ASCII to Unicode, romanized and other character sets

Primary LanguageJavaScriptMIT LicenseMIT

anvaad-js :: ਅਨੁਵਾਦ-ਜੇਅੈਸ

Build Status Coverage Status

Playground

Visit playground website to try the API methods.

Installation

# npm
npm install anvaad-js
# yarn
yarn add anvaad-js

Usage

import * as anvaad from 'anvaad-js' // ES2015 module syntax
// import { unicode } from 'anvaad-js' // ES2015 module destructuring syntax
// const anvaad = require('anvaad-js') // common-js require syntax

anvaad.unicode('myry');

Testing

We use jest for our tests. Run them using npm/yarn

# npm
npm run test
# yarn
yarn test

API Documentation

Table of Contents

ascii

Returns a comma-separated string of ascii codes for a string of Gurmukhi characters

Parameters

  • string string The string of letters

Examples

ascii('AmgAmqmgkp');
// => ',065,109,103,065,109,113,109,103,107,112,'

Returns string Returns a single string of comma-separated ascii codes

Meta

  • since: 1.0.0

firstLetters

Retrieve the first letter of each word from a string

Parameters

  • words string The string from which to get first letters
  • eng boolean Whether the string is English (optional, default false)

Examples

firstLetters('Awie imlu gurisK Awie imlu qU myry gurU ky ipAwry ]');
// => 'AmgAmqmgkp'

Returns string Returns a single string of characters

Meta

  • since: 1.0.0

mainLetters

Removes vowel symbols from a Gurmukhi string

Parameters

  • words string The string from which to get main letters

Examples

mainLetters('Awie imlu gurisK Awie imlu qU myry gurU ky ipAwry ]');
// => 'Ae ml grsK Ae ml q mr gr k pAr'

Returns string Returns a single string of characters

Meta

  • since: 1.0.0

translit

Returns a transliteration of Gurmukhi script

Parameters

  • gurmukhi string The string from to generate transliteration

Examples

translit('Awie imlu gurisK Awie imlu qU myry gurU ky ipAwry ]');
// => 'aai mil gurasikh aai mil too mayray guroo kay piaaaray ||'

Returns string Returns a string of text

Meta

  • since: 1.0.0

unicode

Convert Gurmukhi script to Unicode

Parameters

  • text string Gurbani Akhar script to be converted

Examples

unicode('Awie imlu gurisK Awie imlu qU myry gurU ky ipAwry ]');
// => 'ਆਇ ਮਿਲੁ ਗੁਰਸਿਖ ਆਇ ਮਿਲੁ ਤੂ ਮੇਰੇ ਗੁਰੂ ਕੇ ਪਿਆਰੇ ॥'

Returns string Returns unicode text

Meta

  • since: 1.0.0

Notes

All letter conversions at a minimum must address the following letters that are utilized within gurbani ascii fonts:

´
`
^
¨
~
<
>
|
µ
 
-
,
:
!
?
/
'
‘
’
(
)
[
]
®
@
¤
\
&
˜
†
0
1
2
3
4
5
6
7
8
9
a
A
b
B
c
C
ç
d
D
e
E
f
F
g
G
h
H
i
I
Í
î
Î
j
J
k
K
l
L
m
M
n
N
o
O
Ø
œ
p
P
q
Q
r
R
s
S
t
T
ŧ
u
U
Ú
ü
v
V
w
W
x
X
y
Y
z
Z