inswitch_common_utils
Inswitch common utils encapsula todas las funciones compartidas entre los diferentes proyectos desarrollados en busca de tener el desarrollo de los mismos centralizado y así hacer que sea más fácil y cómodo mantenerlos.
Funcionamiento del proyecto
Se tiene un archivo index.js encargado de exportar todas las funciones implementadas para el uso de los demás proyectos dentro de las dos siguientes variables:
| Variable | Descripción |
|---|---|
| inswitchCommonUtilsRedis | Contiene todas las funciones relacionadas con la manipulación de redis |
| inswitchCommonUtils | Contiene funciones para realizar logs, consultas a APIs, manejo de errores, etc |
Contenido de inswitchCommonUtilsRedis
| Variable | Descripción | Parámetros |
|---|---|---|
| getKey | Recibe como parámetro una key y devuelve el elemento correspondiente a ella si es que existe | @key : string |
| setKey | Crea o reemplaza en redis un registro con la key y el dato recibidos. También permite crear una clave temporal recibiendo un tercer parámetro que contenga el tiempo |
@key : string @value : any @time : int |
| getFirstKeyPattern | Retorna el primer elemento cuya key coincida con el pattern recibido | @pattern : string |
| getMachingKeys | Retorna los primeros 10 elementos cuyas keys coincidan con el pattern recibido | @pattern : string |
| delKey | Elimina el elemento relacionado a la key recibida | @key : string |
Contenido de inswitchCommonUtils
| Variable | Descripción | Parámetros |
|---|---|---|
| logger | Permite utilizar un logger para realizar los logs que sean necesarios | - |
| logActionRequest | Realiza un log de request recibido |
@req : object @action : string @level : string - optional |
| logActionResponse | Realiza un log de respuesta |
@req : object @action : string @result : object @level : string |
| secureQuery | Contiene las funciones de encriptación y decriptación de datos | - |
| replaceSensitiveData | Reemplaza la key password dentro de un objeto y cambia sus datos por "*" |
- |
| createError | Permite crear un error |
@name : string @errorCategory : string @errorCode : string @errorDescription : string @errorDateTime : string @errorParameters : string |
| queryData | Realiza una consulta a la url especificada |
@url : string @method : string @data : any - optional @headers : object - optional @newBaseUrl : string - optional @timeout : int |
| accessTokenTenant | Crea un token de tenant para el usuario recibido |
@username : string @password : string @url : string @header : object |
| response | Realiza una response con los datos recibidos y los logea |
@req : object @res : object @data : any @message : string |