@toil/translate
v1.0.3
Published
A library for free and not only using various translation APIs
Downloads
379
Maintainers
Readme
translate
A library for free and not only using various translation APIs, which supports working with JavaScript, TypeScript, and also has built-in separated types for Typebox.
Installation
Installation via Bun:
bun add @toil/translate
Installation via NPM:
npm install @toil/translate
Getting started
To start working with the API, you need to create a Translation Client. This can be done using the code provided below.
const client = new TranslationClient({
service: TranslationService.yandexbrowser,
});
const translatedResult = await client.translate(
"The quick brown fox jumps over the lazy dog",
);
const detectResult = await client.detect(
"The quick brown fox jumps over the lazy dog",
);
const langs = await client.getLangs();
You can see more code examples here
Available services
| Status | Service | Functions | Limits | | ------ | --------------- | ------------------------------- | ------------------------------ | | ✅ | YandexBrowser | TranslateDetectGetLangs | 10k chars/req10k chars/req | | ✅ | YandexCloud | TranslateDetectGetLangs | 2k chars/req1k chars/req | | ✅ | YandexTranslate | TranslateDetectGetLangs | 10k chars/req10k chars/req | | ✅ | MSEdge | TranslateDetectGetLangs | 50k chars/req50k chars/req |
Build
To build, you must have:
Don't forget to install the dependencies:
bun install
Regular Build
Building the entire package:
bun build:bun
Building a types for TypeBox
You can use this build option if you only want to build types for TypeBox:
bun build:typebox
Tests
The library has minimal test coverage to check it's performance.
Run the tests:
bun test