npm 包 yandex-translate-api-wrapper 使用教程-JavaScript中文网-JavaScript教程资源分享门户

前言

在开发前端应用的过程中，经常需要使用到翻译功能。目前，市面上已经有很多翻译 API 供开发者使用，其中最具代表性的是 Google Translate API。但是，由于某些原因，Google 翻译服务在部分地区无法访问。那么有没有其它好用的翻译 API 呢？答案是肯定的！Yandex 翻译 API 就是一个很不错的选择。在本篇文章中，我们将介绍如何使用 npm 包 yandex-translate-api-wrapper 来轻松地集成 Yandex 翻译服务到你的前端应用中。

yandex-translate-api-wrapper 的安装

首先，我们需要通过 npm 安装 yandex-translate-api-wrapper 包。在终端中执行以下命令即可：

npm i yandex-translate-api-wrapper

使用示例

接下来，我们来看一下如何使用 yandex-translate-api-wrapper 包。

首先，我们需要在 Yandex 自己的网站上申请一个翻译 API 的 key。在注册 Yandex 开发者账号后，我们就可以在这里申请到自己的 key 了。

在获取到 key 后，我们就可以开始在代码中使用 yandex-translate-api-wrapper 包了。下面是一个简单的使用示例：

import YandexTranslate from 'yandex-translate-api-wrapper';

const api_key = 'your_yandex_api_key';
const translate = new YandexTranslate(api_key);

translate.translate('Hello, world!', 'en-zh').then(res => {
  console.log(res.text); // 输出：你好，世界！
});

在这个示例中，我们首先导入 yandex-translate-api-wrapper 包，并声明了我们的 Yandex API key。然后，我们创建了一个 YandexTranslate 的实例，并利用它来进行翻译。在调用 translate 方法时，我们传入了要翻译的文本（'Hello, world!'）和目标语言代码（'en-zh'，表示从英语翻译为中文）。在翻译完成后，我们将结果输出到了控制台中。

API 文档

yandex-translate-api-wrapper 包的 API 非常简单，只有三个方法：

translate(text: string, lang: string): Promise<TranslateResponse>：用于翻译文本。
detect(text: string): Promise<LanguageResponse>：用于自动检测文本的语言。
getLangs(ui: string): Promise<LanguageResponse>：用于获取可用的翻译语言。

其中，Promise 对象表示异步操作的结果。在实际使用中，我们可以通过 then() 方法来处理 Promise 对象的结果。下面是一个 translate 方法的详细说明：

translate 方法

translate(text: string, lang: string): Promise<TranslateResponse>

text：要翻译的文本。
lang：目标语言代码。例如，'en-zh' 表示从英语翻译为中文，'zh-en' 表示从中文翻译为英语。
Promise<TranslateResponse>：返回一个 Promise 对象，用于处理异步操作的结果。

translate 方法的返回值是一个 Promise 对象。当翻译完成后，Promise 对象会返回一个 TranslateResponse 对象，其中包含以下属性：

code: number：状态码。
text: string[]：翻译后的文本。如果翻译失败，则该数组为空。
lang: string：目标语言代码。如果翻译失败，则该值为空。

detect 方法

detect(text: string): Promise<LanguageResponse>

text：要自动检测的文本。
Promise<LanguageResponse>：返回一个 Promise 对象，用于处理异步操作的结果。

detect 方法的返回值是一个 Promise 对象。当检测完成后，Promise 对象会返回一个 LanguageResponse 对象，其中包含以下属性：

code: number：状态码。
lang: string：检测出的语言代码。如果检测失败，则该值为空。

getLangs 方法

getLangs(ui: string): Promise<LanguageResponse>

ui：界面语言代码。例如，'en' 表示英语，'zh' 表示中文。
Promise<LanguageResponse>：返回一个 Promise 对象，用于处理异步操作的结果。

getLangs 方法的返回值是一个 Promise 对象。当获取完成后，Promise 对象会返回一个 LanguageResponse 对象，其中包含以下属性：

code: number：状态码。
langs: {[key: string]: string}：可用的语言列表。其中，key 表示语言代码，value 表示语言名称。

总结

到此为止，我们已经学习了如何使用 yandex-translate-api-wrapper 包来轻松地集成 Yandex 翻译服务到我们的前端应用中。在实际开发中，我们可以根据需要使用 translate、detect 和 getLangs 方法来实现不同的功能。希望本文对你有所帮助！

来源：JavaScript中文网，转载请注明来源 https://www.javascriptcn.com/post/60055f3d81e8991b448dccb2