Translate

简体中文 | English

Translate 是一个支持多翻译引擎的翻译工具库，它提供了一套简单的api，让你可以轻松将一种语种翻译成另外一种语种。

❓ 为什么需要Translate?

市面上不少翻译工具库，基本都不太维护了
不是ts写的，使用时提示不够友好
功能单一，不支持批量翻译 or 只支持一种翻译引擎
...

说明：Translate 全部帮你搞定以上问题，未来将拓展更多内容

✨ 特点

🌐 多环境支持：Node环境、浏览器环境
✨ 简单易用：提供了简洁的API，就可以轻松帮你翻译
🌍 支持多翻译引擎：Google、Azure Translate、Amazon Translate、Deepl、Baidu、OpenAI等（未来将拓展更多）
🛠️ typescript: 更友好的代码提示和质量保障
📦 批量翻译：一次api请求，翻译更多内容，减少http请求提高翻译效率
🔓 完全开源

特别提醒：虽然库已支持浏览器环境使用，但是请仅使用google engine翻译(google不需要key)，使用其他翻译engine 需要配置key，在前端使用会导致key泄露，千万不要这么做

💻翻译引擎，集成情况

name	支持	描述
google	√	已投产，可以正常使用
azure translate	√	已投产，可以正常使用
amazon translate	√	已投产，可以正常使用
baidu	√	已投产，可以正常使用
deepl	√	已投产，可以正常使用
openai	√	已投产，可以正常使用
yandex		由于我没有平台支持的银行账号，所以未调通（欢迎有条件的朋友帮忙调通，感谢）

🚀 安装

npm
```
npm install @yxw007/translate
```
yarn
```
yarn add @yxw007/translate
```
pnpm
```
pnpm i @yxw007/translate
```

📖 使用

Node

ESM

import { translator, engines } from "@yxw007/translate"

Commonjs

const { translator, engines }  = required("@yxw007/translate")

example

translator.addEngine(engines.google());
const res1 = await translator.translate("hello", { from: "en", to: "zh" });
console.log(res1);

const res2 = await translator.translate(["hello", "good"], { from: "en", to: "zh", engine: "google" });
console.log(res2);

输出结果

['你好']
["你好", "好的"]

Browser

使用 jsDelivr CDN

development

<script src="https://cdn.jsdelivr.net/npm/@yxw007/translate@0.0.7/dist/browser/index.umd.js"></script>

production

<script src="https://cdn.jsdelivr.net/npm/@yxw007/translate@0.0.7/dist/browser/index.umd.min.js"></script>

example

<!DOCTYPE html>
...

<head>
  ...
  <script src="https://cdn.jsdelivr.net/npm/@yxw007/translate@0.0.7/dist/browser/index.umd.js"></script>
</head>

<body>
  <script>
    (async () => {
      const { engines, translator } = translate;
      translator.addEngine(engines.google());
      const res = await translator.translate("hello", { from: "en", to: "zh" });
      console.log(res);
    })();
  </script>
</body>

</html>

📚 API

Translator

class Translator {
  private engines: Map<string, Engine>;
  constructor() {
    this.engines = new Map<string, Engine>();
  }
  /**
   * This method is obsolete, please use the addEngine method
   * @param engine {@link Engine}  instance
   * @deprecated Use {@link addEngine} instead.
   */
  use(engine: Engine) {
    this.addEngine(engine);
  }
  addEngine(engine: Engine) {
   ...
  }
  removeEngine(engineName: string) {
   ...
  }
  translate<T extends Engines>(text: string | string[], options: TranslateOptions<T>) {
    ...
  }
}

`use`

给translator添加翻译引擎

export type Engine = {
  name: string;
  translate: <T extends Engines>(text: string | string[], opts: EngineTranslateOptions<T>) => Promise<string[]>;
};

`translate`

可以传一个文本or传一个文本数组，将返回一个翻译后的Promise<string[]>

translate: <T extends Engines>(text: string | string[], opts: EngineTranslateOptions<T>) => Promise<string[]>;

TranslateOptions

export type TranslateOptions<T extends Engines> = {
  from?: FromLanguage<T>;
  to: ToLanguage<T>;
  engine?: T;
  /**
   * Cache time in milliseconds
   */
  cache_time?: number | undefined;
  /**
   * Domain to use for translation
   */
  domain?: string | undefined;
};

提示：如需了解各Engine语言支持情况，请到以下目录查看对应配置

from: https://github.com/yxw007/translate/blob/master/src/language/origin/index.ts
to: https://github.com/yxw007/translate/blob/master/src/language/target/index.ts

各翻译Engine的Option

BaseEngineOption

interface BaseEngineOption {}

AzureEngineOption

interface AzureEngineOption extends BaseEngineOption {
  key: string;
  region: string;
}

说明：option param 请从对应平台获取

相关文档：rest-api-guide

AmazonEngineOption

interface AmazonEngineOption extends BaseEngineOption{
  region: string;
  accessKeyId: string;
  secretAccessKey: string;
}

说明：option param 请从对应平台获取

相关文档：https://docs.aws.amazon.com/translate/latest/dg/what-is.html
相关库：https://www.npmjs.com/package/@aws-sdk/client-translate

BaiduEngineOption

export interface BaiduEngineOption extends BaseEngineOption {
  appId: string;
  secretKey: string;
}

说明：option param 请从对应平台获取

相关文档：https://fanyi-api.baidu.com/product/121

DeeplEngineOption

export interface DeeplEngineOption {
  key: string;
}

说明：option param 请从对应平台获取

相关文档：https://www.deepl.com/en/your-account/keys

OpenAIEngineOption

export interface OpenAIEngineOption {
  apiKey: string;
  model: OpenAIModel;
}

export const OPEN_AI_MODELS = [
  "o1-preview",
  "o1-preview-2024-09-12",
  "o1-mini-2024-09-12",
  "o1-mini",
  "dall-e-2",
  "gpt-3.5-turbo",
  "gpt-3.5-turbo-0125",
  "babbage-002",
  "davinci-002",
  "dall-e-3",
  "text-embedding-3-large",
  "gpt-3.5-turbo-16k",
  "tts-1-hd-1106",
  "text-embedding-ada-002",
  "text-embedding-3-small",
  "tts-1-hd",
  "whisper-1",
  "gpt-3.5-turbo-1106",
  "gpt-3.5-turbo-instruct",
  "gpt-4o-mini-2024-07-18",
  "gpt-4o-mini",
  "tts-1",
  "tts-1-1106",
  "gpt-3.5-turbo-instruct-0914",
] as const;

export type OpenAIModel = (typeof OPEN_AI_MODELS)[number];

说明：option param 请从对应平台获取

相关文档：https://platform.openai.com/settings/organization/api-keys

🤝 贡献

特别注意：请基于master创建一个新分支，在新分支上开发，开发完后创建PR至master

安装依赖
```
pnpm install
```

添加新Engine

添加新平台engine插件

export interface XXEngineOption extends BaseEngineOption {
  key: string;
}

export function xx(options: XXEngineOption): Engine {
  const { key } = options;
  const base = "https://translate.yandex.net/api/v1.5/tr.json/translate";
  return {
    name: "xx",
    async translate<T extends Engines>(text: string | string[], opts: EngineTranslateOptions<T>) {
      const { from, to } = opts;
      if (!Array.isArray(text)) {
        text = [text];
      }
      //TODO: 调用平台翻译api
      const translations: string[] = [];
      //TODO: 解析平台API相应结果，将结果解析至translations返回
      for (const translation of body.text) {
        if (translation) {
          translations.push(translation);
        }
      }
      return translations;
    },
  };
}

将插件添加至engines(位置：/src/engines/index.ts)

import { xxx } from "./xxx";
export const engines = {
  google,
  azure,
  amazon,
  baidu,
  deepl,
  openai,
  xxx
} as const;

添加对应Engine支持的origin语言配置

//说明：如果origin与target语言都一样，那么可以直接用target语言配置即可，否则请单独配置
//src/language/origin/index.ts  
import azure from "../target/azure";
...
import xxx from "../target/xxx"

export const originLanguages = {
  azure: azure,
  ...
  xxx: xxx,
} as const;

export type originLanguageMapNames = {
  amazon: keyof typeof amazon;
  ...
  xxx: keyof typeof xxx;
};

export type originLanguageMapValues = {
  amazon: ValuesOf<typeof amazon>;
  ...
  xxx: ValuesOf<typeof xxx>;
};

添加对应Engine支持的target语言配置

//src/language/target/index.ts  
import azure from "./azure";
...
import xxx from "./amazon";

export const targetLanguages = {
  azure: azure,
  ...
  xxx: xxx,
} as const;

export type targetLanguageMapNames = {
  amazon: keyof typeof amazon;
  ...
  xxx: keyof typeof xxx;
};

export type targetLanguageMapValues = {
  amazon: ValuesOf<typeof amazon>;
  ...
  xxx: ValuesOf<typeof xxx>;
};

打包
```
pnpm build
```
测试
```
pnpm test
```

提示：目前库已可以正常使用，欢迎大家体验、如果你有任何问题和建议都可以提Issue给我反馈。如果你感兴趣，特别欢迎你的加入，让我们一起完善好这个工具。帮忙点个star⭐，让更多人知道这个工具，感谢大家🙏

🌹 特别致谢

franciscop/translate

说明：感谢franciscop/translate为我快速实现这个库提供了思路，同时也间接了他的部分代码。非常感谢🙏

📄 许可证

Translate 是在 MIT 许可证下发布的。详情请见 LICENSE 文件。

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

README_zh-CN.md

README_zh-CN.md

Translate

❓ 为什么需要Translate?

✨ 特点

💻翻译引擎，集成情况

🚀 安装

📖 使用

Node

Browser

📚 API

Translator

`use`

`translate`

TranslateOptions

各翻译Engine的Option

BaseEngineOption

AzureEngineOption

AmazonEngineOption

BaiduEngineOption

DeeplEngineOption

OpenAIEngineOption

🤝 贡献

🌹 特别致谢

📄 许可证

Files

README_zh-CN.md

Latest commit

History

README_zh-CN.md

File metadata and controls

Translate

❓ 为什么需要Translate?

✨ 特点

💻翻译引擎，集成情况

🚀 安装

📖 使用

Node

Browser

📚 API

Translator

use

translate

TranslateOptions

各翻译Engine的Option

BaseEngineOption

AzureEngineOption

AmazonEngineOption

BaiduEngineOption

DeeplEngineOption

OpenAIEngineOption

🤝 贡献

🌹 特别致谢

📄 许可证

`use`

`translate`