tf-translator
v1.0.1
Published
Simple Google Translate API wrapper for Node.js
Readme
Parameters
The Translate() function accepts the following parameters:
| Parameter | Type | Description | Default Value |
|-------------|----------|------------------------------------------------------------------------------|---------------|
| text | string | The text that you want to translate. | None |
| from | string | The language of the input text. If not provided, the language will be auto-detected. | 'auto' |
| to | string | The language to which the text should be translated (required). | None |
| allowSame | boolean| If false, prevents translation if the source and target languages are the same. If true, translation proceeds even if the languages are the same. | false |
Parameter Details:
text: This is the primary input text that you want to translate. It is a required parameter, and the translation will be based on this string.from: This parameter specifies the source language of the input text. If left as'auto', the function will automatically detect the language. Common language codes include'en'for English,'es'for Spanish,'so'for Somali, etc. If you want to explicitly specify the source language, you can provide the corresponding language code here.to: This is the required parameter that defines the target language for the translation. It specifies into which language thetextwill be translated. The language code must be a valid ISO language code, such as'en'for English,'fr'for French,'de'for German, etc.allowSame: A boolean flag that determines whether the translation will be skipped if the source and target languages are the same. If set tofalse, the translation will be skipped if thefromandtolanguages are identical. If set totrue, translation will proceed even if the source and target languages are the same.
Example of Usage:
const msg = await Translate("Hello, how are you?", { from: "auto", to: "so", allowSame: false });
if (msg) {
console.log("Translated Text:", msg.text); // Output: "Iska warran, sidee tahay?"
console.log("Original Language:", msg.lang[0]); // Output: "en" (English)
console.log("Target Language:", msg.lang[1]); // Output: "so" (Somali)
console.log("Is Same Language:", msg.is_same); // Output: false
} else {
console.log("Translation skipped (same language).");
}