@indic-transliteration/sanscript/types/sanscript.d.ts

Sanscript is a transliteration library for Indian languages. It supports the most popular Indian scripts and several different romanization schemes. Although Sanscript focuses on Sanskrit transliteration, it has partial support for other languages and is

export type PreferredAlternates = {[key:string]:{[key:string]:string}};

export type Scheme = {[key:string]:{[key:string]:string}};

export type Options = {
    skip_sgml?: boolean;
    syncope?: boolean;
    preferred_alternates?: PreferredAlternates;
}


declare namespace Sanscript {
    /**
     * Default options that are used during every Sanscript.t call.
     */
    let defaults:Options;

    /**
     * Schemes that are loaded
     */
    let schemes: {[key:string]:Scheme};

    /**
     * Transliterate from one script to another.
     *
     * @param data     the string to transliterate
     * @param from     the source script
     * @param to       the destination script
     * @param options  transliteration options
     * @return         the finished string
     */
    function t(data: string, from: string, to: string, options?: Options): string;

    /**
     * Add a roman scheme to Sanscript.
     *
     * See the comments on Sanscript.addBrahmicScheme. The "vowel_marks" field
     * can be omitted.
     *
     * @param name    the scheme name
     * @param scheme  the scheme data itself
     */
    function addRomanScheme(name: string, scheme: Scheme): void;

    /**
     * Add a Brahmic scheme to Sanscript.
     *
     * Schemes are of two types: "Brahmic" and "roman". Brahmic consonants
     * have an inherent vowel sound, but roman consonants do not. This is the
     * main difference between these two types of scheme.
     *
     * A scheme definition is an object ("{}") that maps a group name to a
     * list of characters. For illustration, see the "devanagari" scheme at
     * the top of this file.
     *
     * You can use whatever group names you like, but for the best results,
     * you should use the same group names that Sanscript does.
     *
     * @param name    the scheme name
     * @param scheme  the scheme data itself. This should be constructed as
     *                described above.
     */
    export function addBrahmicScheme(name: string, scheme: Scheme): void;
}

export default Sanscript;