vitalets / google-translate-api

A free and unlimited API for Google Translate :dollar: :no_entry_sign:
MIT License
935 stars 118 forks source link

Type definitions #50

Closed olavoparno closed 3 years ago

olavoparno commented 4 years ago

Hey mister, firstly thanks for the lib. It is awesome. Secondly, could you add these type definitions in your project?

Just copy it to a file index.d.ts in case you don't know already.

Thank you again!

export = googleTranslateApi

declare function googleTranslateApi(
  query: string,
  opts?: googleTranslateApi.IOptions,
): Promise<googleTranslateApi.ITranslateResponse>

declare namespace googleTranslateApi {
  export interface IOptions {
    from?: string
    to?: string
  }

  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
  }

  export enum language {
    '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',
  }
}
vitalets commented 3 years ago

@olavoparno thanks a lot! Published as v5.0.0.