lipimala
v1.2.0
Published
Exact Round-Trip IAST/extended Indic transliteration for Devanagari, Gujarati, plain English and canonical reverse conversion.
Maintainers
Readme
lipimala for JavaScript
IAST-style transliteration for Devanagari and Gujarati, with canonical reverse conversion, direct script conversion, and Plain-English or Hunterian output.
Install
npm install lipimalaRequires Node.js 20 or newer and uses ECMAScript modules.
Use
import {
toDevanagariFromIast,
toCanonicalIastFromGujarati,
toPlainEnglishFromDevanagari,
toPlainEnglishFromGujarati,
toCanonicalGujaratiFromDevanagari,
} from 'lipimala';
console.log(toDevanagariFromIast('Kṛṣṇa')); // कृष्ण
console.log(toCanonicalIastFromGujarati('કૃષ્ણ')); // kṛṣṇa
console.log(toPlainEnglishFromDevanagari('कानपुर')); // kaanpur
console.log(toPlainEnglishFromGujarati('આજ મારે')); // aaj maare
console.log(toCanonicalGujaratiFromDevanagari('कृष्ण')); // કૃષ્ણUse toHunterianFromDevanagari() and toHunterianFromGujarati() for simplified ASCII Hunterian: one letter per long vowel and no consonant dots. That is the map and signboard spelling, not the 1954 macron form (jān). See the API reference. Array helpers such as toDevanagariFromIastList() convert lists of strings.
Profiles and options
Forward conversion accepts strictIast, iso15919Core, or extendedIndic profiles. The default is extendedIndic. Options control normalization, unknown input, digits, punctuation, Vedic accents, whitespace, and exact-source metadata.
Direct Devanagari and Gujarati reading accepts BrahmicPlainEnglishOptions. Defaults stay the 1.1 output. 1.2.0 adds an opt-in natural reading. Examples are in the API reference.
Preserve the original input
The rendered script may not encode the original Latin spelling, capitalization, or normalization. A result envelope keeps the source beside the rendered value:
import { toDevanagari } from 'lipimala';
const result = toDevanagari('Kṛṣṇa');
console.log(result.rendered); // कृष्ण
console.log(result.restoreOriginal()); // KṛṣṇaFor a standalone string, set embedExactSourceMetadata: true in the conversion options and use an exact reverse function such as toExactIastFromDevanagari(). Unicode-tag metadata can be removed by systems that sanitize invisible characters.
License
MIT. See LICENSE.
