README
Traductor de campos
Este modulo esta diseñado para poder traducir los campos de la base de datos de siclik de español-ingles e ingles-español.
Instalación
Para poder hacer uso del módulo en el api que se desea implementar, es necesario agregarlo al proyecto con los siguientes comandos:
// usando NPM
$ npm install @compusoluciones/siclik-translate
// usando YARN
$ yarn add @compusoluciones/siclik-translate
Agregar al diccionario
Para que el traductor pueda realizar su trabajo, es necesario agregar al diccionario los campos que queremos que pueda traducir, por ejemplo, si en la base de datos de clientes queremos que traduzca el campo id_cliente tenemos que dirigirnos al archivo dictionaries/customers.js y agregarlo de manera que en el nombre de la propiedad este tal cual como esta en la base de datos o en español y como valor su significado en ingles.
{ es: "id_cliente", en: "customerId" }
Modo de uso
Para usar el traductor una vez que el diccionario tenga las traducciones que necesitamos, haremos lo siguiente:
const translate = require('@compusoluciones/siclik-translate');
function pruebaTradutor(obj) {
const traduccion = translate.es_en(obj);
return llamadaBD.agregarUsuario(traduccion);
}
Nota
El traductor ofrece dos funciones: es_en
que traduce de español a ingles y en_es
que traduce del ingles al español.
Cada una de las funciones de traducción recibe como parámetro un objeto con los campos a traducir (solo traduce las propiedades no los valores) y devuelve un objeto nuevo traducido de las cuales solo las que estaban en el diccionario traduce, ya que si la palabra no esta registrada la devolvera de la misma manera en la que la recibio.