Nightly Panic Munchies

    @vitalets/google-translate-api
    TypeScript icon, indicating that this package has built-in type declarations

    9.1.0 • Public • Published

    google-translate-api

    Actions Status NPM version license

    A free and unlimited API for Google Translate for Node.js.

    In version 9+ library was fully rewritten. For legacy documentation please see legacy branch.

    Contents

    Features

    Installation

    npm install @vitalets/google-translate-api
    

    Usage

    Node.js

    import { translate } from '@vitalets/google-translate-api';
    
    const { text } = await translate('Привет, мир! Как дела?', { to: 'en' });
    
    console.log(text) // => 'Hello World! How are you?'

    React-native

    Since react-native has full support of fetch API translation works the same way as in Node.js.

    Web pages

    This library does not work inside web pages because translate.google.com does not provide CORS headers allowing access from other domains.

    Browser extensions

    Although library does not work in regular web pages it can be used in browser extensions. Extensions background and popup pages are not limited with same origin policy. To use translation API you should do the following:

    1. Add host permissions to manifest.json:

      + "host_permissions": [
      +    "https://translate.google.com/"
      +  ]
    2. Import translate as usual in background or popup script:

      // background.js
      import { translate } from '@vitalets/google-translate-api';
      
      const { text } = await translate('Привет мир');
      
      console.log(text);
    3. Bundle code (for example with webpack):

      // webpack.config.js
      module.exports = {
        mode: 'development',
        entry: './background.js',
        output: {
          filename: 'bundle.js',
        },
      };

    Limits

    Google Translate has request limits. If too many requests are made, you can get a TooManyRequestsError (code 429). You can use proxy to bypass it:

    import { translate } from '@vitalets/google-translate-api';
    import createHttpProxyAgent from 'http-proxy-agent';
    
    const agent = createHttpProxyAgent('http://103.152.112.162:80');
    const { text } = await translate('Привет, мир!', {
      to: 'en',
      fetchOptions: { agent },
    });

    See [examples/with-proxy.ts] for more details.

    Available proxy list you can find here (with yes in Google column).

    Common pattern for selecting proxy is following:

      try {
        const { text } = await translate('Привет, мир!', {
          to: 'en',
          fetchOptions: { agent },
        });
      } catch (e) {
        if (e.name === 'TooManyRequestsError') {
          // retry with another proxy agent
        }
      }

    API

    translate(text: string, options?: Options): Promise<Response>

    Parameters

    • text (string) - The text to be translated
    • options (object)
      • from (string) - The language of text. Must be auto or one of the supported languages. Default: auto
      • to (string) - The language in which the text should be translated. Must be one of the supported languages. Default: auto
      • host (string) - Google translate host to be used in API calls. Default: translate.google.com
      • fetchOptions (object) - Additional fetch options passed into request.

    Response

    • text (string) – The translated text.
    • raw (object) - Raw responspe from the API. Contains sentences, detected original language and transliteration. Example response.

    Related projects

    License

    MIT © Matheus Fernandes, forked and maintained by Vitaliy Potapov.

    Buy Me A Coffee

    Install

    npm i @vitalets/google-translate-api

    DownloadsWeekly Downloads

    29,699

    Version

    9.1.0

    License

    MIT

    Unpacked Size

    31.1 kB

    Total Files

    31

    Last publish

    Collaborators

    • vitalets