index.d.ts

export = googleTranslateApi;

declare function googleTranslateApi(
  text: string,
  options?: googleTranslateApi.IOptions,
  gotOptions?: any
): Promise<googleTranslateApi.ITranslateResponse>;

declare namespace googleTranslateApi {
  export interface IOptions {
    from?: string;
    to?: string;
    raw?: boolean;
    client?: 't'|'gtx';
    tld?: string;
    endpoints?: ('website' | 'dictExt' | 'api')[];
    randomEndpoint?: boolean;
    endpointFallback?: boolean;
  }

  export interface ITranslateLanguage {
    didYouMean: boolean;
    iso: string;
  }

  export interface ITranslateText {
    autoCorrected: boolean;
    value: string;
    didYouMean: boolean;
  }

  export interface ITranslateResponse {
    text: string;
    pronunciation: string;
    from: {
      language: ITranslateLanguage;
      text: ITranslateText;
    };
    raw: string | object;
  }

  export enum languages {
    "zh-CN" = "Chinese (Simplified)",
    "zh-TW" = "Chinese (Traditional)",
    af = "Afrikaans",
    am = "Amharic",
    ar = "Arabic",
    auto = "Automatic",
    az = "Azerbaijani",
    be = "Belarusian",
    bg = "Bulgarian",
    bn = "Bengali",
    bs = "Bosnian",
    ca = "Catalan",
    ceb = "Cebuano",
    co = "Corsican",
    cs = "Czech",
    cy = "Welsh",
    da = "Danish",
    de = "German",
    el = "Greek",
    en = "English",
    eo = "Esperanto",
    es = "Spanish",
    et = "Estonian",
    eu = "Basque",
    fa = "Persian",
    fi = "Finnish",
    fr = "French",
    fy = "Frisian",
    ga = "Irish",
    gd = "Scots Gaelic",
    gl = "Galician",
    gu = "Gujarati",
    ha = "Hausa",
    haw = "Hawaiian",
    he = "Hebrew",
    hi = "Hindi",
    hmn = "Hmong",
    hr = "Croatian",
    ht = "Haitian Creole",
    hu = "Hungarian",
    hy = "Armenian",
    id = "Indonesian",
    ig = "Igbo",
    is = "Icelandic",
    it = "Italian",
    iw = "Hebrew",
    ja = "Japanese",
    jw = "Javanese",
    ka = "Georgian",
    kk = "Kazakh",
    km = "Khmer",
    kn = "Kannada",
    ko = "Korean",
    ku = "Kurdish (Kurmanji)",
    ky = "Kyrgyz",
    la = "Latin",
    lb = "Luxembourgish",
    lo = "Lao",
    lt = "Lithuanian",
    lv = "Latvian",
    mg = "Malagasy",
    mi = "Maori",
    mk = "Macedonian",
    ml = "Malayalam",
    mn = "Mongolian",
    mr = "Marathi",
    ms = "Malay",
    mt = "Maltese",
    my = "Myanmar (Burmese)",
    ne = "Nepali",
    nl = "Dutch",
    no = "Norwegian",
    ny = "Chichewa",
    pa = "Punjabi",
    pl = "Polish",
    ps = "Pashto",
    pt = "Portuguese",
    ro = "Romanian",
    ru = "Russian",
    sd = "Sindhi",
    si = "Sinhala",
    sk = "Slovak",
    sl = "Slovenian",
    sm = "Samoan",
    sn = "Shona",
    so = "Somali",
    sq = "Albanian",
    sr = "Serbian",
    st = "Sesotho",
    su = "Sundanese",
    sv = "Swedish",
    sw = "Swahili",
    ta = "Tamil",
    te = "Telugu",
    tg = "Tajik",
    th = "Thai",
    tl = "Filipino",
    tr = "Turkish",
    uk = "Ukrainian",
    ur = "Urdu",
    uz = "Uzbek",
    vi = "Vietnamese",
    xh = "Xhosa",
    yi = "Yiddish",
    yo = "Yoruba",
    zu = "Zulu",
  }

  namespace languages {
    /**
     * Returns the ISO 639-1 code of the desiredLang – if it is supported by Google Translate
     * @param desiredLang – the name or the code(case sensitive) of the desired language
     * @returns The ISO 639-1 code of the language or false if the language is not supported
     */
    function getCode(desiredLang: string): string | boolean;

    /**
     * Returns true if the desiredLang is supported by Google Translate and false otherwise
     * @param desiredLang – the ISO 639-1 code or the name of the desired language
     */
    function isSupported(desiredLang: string): boolean;
  }
}