properties-translator
v1.0.1
Published
Properties file translator using Azure for Node.js
Downloads
3
Readme
Properties Translator v1.0
Install using
npm properties-translator
Usage example:
const Translator = require('properties-translator');
const config = {
targetLanguages: ['pt', 'fr'],
sourceFile: './lang_en.properties',
sourceLang: 'en',
translateDir: './translated_files',
langFilePrefix: 'lang_',
log: true,
azureConfig: {
subscriptionKey: 'YOUR_AZURE_TRANSLATOR_KEY',
region: 'YOUR_AZURE_TRANSLATOR_REGION',
endpoint: 'https://api.cognitive.microsofttranslator.com',
version: '3.0',
},
};
const translator = new Translator(config);
translator.translate({ rebuild: false });
- The translated files will be generated in the
translateDir
folder defined inconfig
.
Docs
Configuration
- [Required]
targetLanguages
- Array of strings the with target language codes. - [Required]
sourceFile
- String with the path to your source file. - [Required]
sourceLang
- String with the source file lang. - [Optional]
translateDir
- String with the path to a folder where the translated files will be created. Default to./translated_files
. - [Optional]
langFilePrefix
- String with a prefix name for translated files. Default tolang_
. - [Optional]
log
- Boolean that if set to true, will show the properties being translated in the terminal. Default tofalse
. - [Required]
azureConfig.subscriptionKey
- String with your Azure translator resource key. - [Required]
azureConfig.region
- String with your Azure translator resource region. - [Optional]
azureConfig.endpoint
- String with the azure cognitive translator api endpoint. Default toapi.cognitive.microsofttranslator.com
- [Optional]
azureConfig.version
- String with the azure cognitive translator version. Default to3.0
- [Required]
Functions
translate({ rebuild: boolean })
- Generate the files and translate them according to the configured source file.rebuild
- Parameter that will force all files to be regenerated. The default behaviorfalse
will only add new updates made to the source file, unless it's the first translation.
getTranslatableLangs()
- Returns a promise with an object containing all Azure translatable languages, where the key is the language code and the value is the language name.translateSentence(sentence: string, lang: string)
- Takes a sentence and a language code, then returns a promise with the translation based onsourceLang
.
- You can see Azure Cognitive Translator documentation here
Enjoy! :)