Visit playground website to try the API methods.
# npm
npm install anvaad-js
# yarn
yarn add anvaad-jsimport * 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');We use jest for our tests. Run them using npm/yarn
# npm
npm run test
# yarn
yarn testReturns a comma-separated string of ascii codes for a string of Gurmukhi characters
Parameters
stringstring 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
Retrieve the first letter of each word from a string
Parameters
wordsstring The string from which to get first lettersengboolean Whether the string is English (optional, defaultfalse)simplifyboolean Whether to simplify embedded vowels and other characters (eg. E to a, ^ to K)
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
Removes vowel symbols from a Gurmukhi string
Parameters
wordsstring The string from which to get main letterssimplifyboolean Whether to simplify embedded vowels/nasal sounds (eg. E to a, ^ to K)simplifyConsonantsboolean Whether to simplify half characters to full characters (eg. R to r)
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
Returns a transliteration of Gurmukhi script
Parameters
gurmukhistring 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
Convert Gurmukhi script to Unicode and back again.
Parameters
textstring Gurbani Akhar or Unicode script to be convertedreverseboolean Whether to convert ASCII to unicode (false by default)simplifyboolean Whether to simplify extended characters to single code points (eg. sæ to ਸ਼ (u0A36), ਸ਼ (u0A38u0A3C) to S) (false by default)
Examples
unicode('Awie imlu gurisK Awie imlu qU myry gurU ky ipAwry ]');
// => 'ਆਇ ਮਿਲੁ ਗੁਰਸਿਖ ਆਇ ਮਿਲੁ ਤੂ ਮੇਰੇ ਗੁਰੂ ਕੇ ਪਿਆਰੇ ॥'Returns string Returns unicode text
* unicode('ਆਇ ਮਿਲੁ ਗੁਰਸਿਖ ਆਇ ਮਿਲੁ ਤੂ ਮੇਰੇ ਗੁਰੂ ਕੇ ਪਿਆਰੇ ॥', true);
* // => 'Awie imlu gurisK Awie imlu qU myry gurU ky ipAwry ]'Returns string Returns gurbani akhar ascii 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
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent
