Microsoft Translate API

A stable and powerful zero-dependency free translator for Microsoft Translator designed for Node.js.

Install

NPM

npm install microsoft-translate-api

Bun

bun add microsoft-translate-api

Basic Usage

Translate from Auto-Detected Language to Another Language

1const { translate } = require('microsoft-translate-api')
2
3translate('你好，很高兴认识你！', null, 'en').then(res => {
4  console.log(res);
5}).catch(err => {
6  console.error(err);
7});

1[
2  {
3    "detectedLanguage": {
4      "language": "zh-Hans",
5      "score": 1
6    },
7    "translations": [
8      {
9        "text": "Hello, nice to meet you!",
10        "to": "en"
11      }
12    ]
13  }
14]

Translate from Auto-Detected Language to Multiple Languages

1const { translate } = require('microsoft-translate-api')
2
3translate('你好，很高兴认识你！', null, ['en', 'ja']).then(res => {
4  console.log(res);
5}).catch(err => {
6  console.error(err);
7});

1[
2  {
3    "detectedLanguage": {
4      "language": "zh-Hans",
5      "score": 1
6    },
7    "translations": [
8      {
9        "text": "Hello, nice to meet you!",
10        "to": "en"
11      },
12      {
13        "text": "こんにちは、はじめまして!",
14        "to": "ja"
15      }
16    ]
17  }
18]

Translate HTML text

1const { translate } = require('microsoft-translate-api')
2
3const htmlText = `
4  <div class="notranslate">This will not be translated.</div>
5  <div>This will be translated.</div>
6`;
7translate(htmlText, null, 'zh-Hans', {
8  translateOptions: {
9    // Explicitly set textType as `html`. Defaults to `plain`.
10    textType: 'html'
11  }
12}).then(res => {
13  console.log(res);
14}).catch(err => {
15  console.error(err);
16});

1[
2  {
3    "detectedLanguage": {
4      "language": "en",
5      "score": 1
6    },
7    "translations": [
8      {
9        "text": "<div class=\"notranslate\">This will not be translated.</div>\n<div>这将被翻译。</div>",
10        "to": "zh-Hans"
11      }
12    ]
13  }
14]

Optional Translation Options

Reference

1interface TranslateOptions {
2  translateOptions?: Record<string, object>;
3  authenticationHeaders?: Record<string, string>;
4  userAgent?: string;
5  fetchOptions?: RequestInit;
6}

Full Translation Results

Reference

1interface TranslationResult {
2  translations: {
3    text: string;
4    to: string;
5    sentLen?: {
6      srcSentLen: number[];
7      transSentLen: number[];
8    };
9    transliteration?: {
10      script: string;
11      text: string;
12    };
13    alignment?: object;
14  }[];
15  detectedLanguage?: {
16    language: string;
17    score: number;
18  };
19}

Supported Languages

Refer to lang.json.

Service Limits

https://learn.microsoft.com/azure/ai-services/translator/service-limits#character-and-array-limits-per-request

[!NOTE] Note that the correction service is not available.

Use Paid Service With Your Private Keys

1const { translate } = require('microsoft-translate-api')
2
3translate('你好，很高兴认识你！', null, 'en', {
4  authenticationHeaders: {
5    // Use private subscription key
6    'Ocp-Apim-Subscription-Key': 'YOUR KEY',
7    // Or use a JWT token
8    'Authorization': 'YOUR TOKEN'
9  }
10}).then(res => {
11  console.log(res);
12}).catch(err => {
13  console.error(err);
14});

See also https://learn.microsoft.com/azure/ai-services/translator/reference/v3-0-reference#authentication

[!NOTE] Note that using your private keys, the translator will skip to fetch the free authorization and you will have to check if the authorization is expired by yourself.

Credits

bing-translate-api - This package literally would never exist without this.