A TypeScript library for automating translations across multiple languages using various translation APIs. (Currently only support DeepL API)
- Variable pattern preservation in translations (e.g.,
{name}) - Context-based translation for improved accuracy
- Support for all 33 languages available in DeepL API
- Type safety with TypeScript
- Dual module system support (ESM and CommonJS)
- Smart caching of previously translated content to minimize API costs
- Rate limiting protection with automatic retry and delay
- Translation automation tools for batch processing
npm install ts-translator-auto-coreCreate an .env file with your DeepL API key:
cp .env.example .envThen add your API key:
DEEPL_API_KEY=your_deepl_api_key_here
This library includes examples that can be used in various module system environments:
An example using Node.js CommonJS module system.
// index.js
const { TranslationManager } = require("ts-translator-auto-core");
// Create TranslationManager instance
const translationManager = new TranslationManager(CONFIG, apiKey);
// Execute translation for all languages
await translationManager.translateAll();How to run:
cd src/examples/cjs-example
npm install
node index.jsA TypeScript example using ECMAScript module system.
// index.ts
import {
TranslationManager,
TranslationConfig,
LanguageCode,
} from "ts-translator-auto-core";
// Create TranslationManager instance with ESM module path workaround
const translationManager = new TranslationManager(CONFIG, apiKey);
// Execute translation for all languages
await translationManager.translateAll();How to run:
cd src/examples/esm-example
npm install
npm run translateAn example that works in both ESM and CommonJS environments.
// package.json with "type": "module" setting
{
"name": "ts-translator-module-example",
"type": "module",
"scripts": {
"translate": "tsx index.ts"
}
}How to run:
cd src/examples/module-example
npm install
npm run translate- DeepLTranslator: Uses DeepL API for high-quality translations
- DummyTranslator: For testing and development purposes
All 33 languages supported by DeepL API:
| Language | Code | Language | Code | |
|---|---|---|---|---|
| Arabic | ar | Italian | it | |
| Bulgarian | bg | Japanese | ja | |
| Czech | cs | Korean | ko | |
| Danish | da | Lithuanian | lt | |
| German | de | Latvian | lv | |
| Greek | el | Norwegian | nb | |
| English (US) | en | Dutch | nl | |
| English (UK) | en-GB | Polish | pl | |
| Spanish | es | Portuguese | pt | |
| Estonian | et | Portuguese (Brazil) | pt-BR | |
| Finnish | fi | Romanian | ro | |
| French | fr | Russian | ru | |
| Hungarian | hu | Slovak | sk | |
| Indonesian | id | Slovenian | sl | |
| Swedish | sv | Ukrainian | uk | |
| Turkish | tr | Chinese (Simplified) | zh-Hans | |
| Chinese (Traditional) | zh-Hant |
MIT
To avoid rate limiting errors (429 Too Many Requests), you can configure delay between requests and automatic retries:
import { TranslationManager, DeepLTranslator } from "ts-translator-auto-core";
// Create translator with rate limiting configuration
const translator = new DeepLTranslator(
{
sourceLanguage: "en",
targetLanguage: "ko",
// Add delay between requests (milliseconds)
delayBetweenRequests: 1000,
// Configure retry behavior
maxRetries: 3,
retryDelay: 2000,
},
apiKey
);
// Or configure through TranslationManager
const translationManager = new TranslationManager(
{
// ...your config
translationOptions: {
delayBetweenRequests: 1000,
maxRetries: 3,
retryDelay: 2000,
},
},
apiKey
);The system automatically handles:
- Maintaining delay between consecutive API requests
- Exponential backoff for rate limit errors (429)
- Automatic retry for temporary server errors (5xx)