@oncreditsas/utils

Introduction

Common functions for microservices architecture build on TS

Utils

• codeGenerator: build to generate random OTP codes

• dateFormat: A date formatter in TypeScript using the date-fns library allows you to easily convert dates into readable and customized formats.

• logger: a tool that records events, errors, and messages within an application, making it easier to monitor and debug code. It provides a structured way to store and query information about system behavior.

• uuid: A UUID (Universally Unique Identifier) is a 128-bit alphanumeric code used to uniquely identify information in distributed systems, ensuring that each identifier is globally unique without the need for central coordination.

• alias Fork from module-aliase Create aliases of directories and register custom module paths in NodeJS/TS like a boss!

Usage

codeGenerator

• SOON

dateFormat

• SOON

logger

• SOON

validator

• the validator is a wrapper from express-validator to be used anywhere Para usar el wrapper validador de oncredit sigue los siguientes pasos

// import ESM
import  Validator, { IValidator } from  '../src/validator/index';
const  validator: IValidator = Validator;
await  validator.check(
	// objeto a validar
	obj, 
	// Validaciones (Wrapper from express-validator)
	{ identifier: {
		isString:  true,
		notEmpty:  true,
		errorMessage:  fieldError
		}
	}, 
	// Mensaje y Status error pa generar
	{ message:  generalErrorMessage, status: 404 }
	);

uuid

• readme from uuidv4 options

alias

• readme from module-alias original lib

Para usar el modulo de alias para convertir de TS a Javascript los relative paths, requieres en las variables de entorno agregar la siguiente variable, especificando explicitamente si la compilación de paths esta activada o desactivada, dandole la posiblidad al desarrollador de decidir en que momentos se debe activar esta conversión.

COMPILE_TSPATHS=true

Valores del COMPILE_TSPATHS

• true = active

• false = inactive

// para hacer uso de la conversión de TS a JS usando el tsconfig.json

/*

La conversión funciona tanto en compilación (tsc), como en tiempo de ejecución con TS

*/

require('./alias').initTs();

//or

// para hacer uso de la conversión de relativePaths en NodeJS usando el el package.json

require('./alias').initJs();

  

Support

Support for the library is provided through the OnCredit website. Any issues or incidents can be reported there and will be managed by our dedicated team. We are committed to addressing your concerns promptly and ensuring the best possible experience with our library.

Contributing

This a private npm library, we'll not accept contributions.

License

The ISC license is a permissive free software license published by the Internet Software Consortium, now called Internet Systems Consortium (ISC).

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies

Project status

The project is currently active, with ongoing support and plans for future enhancements and new features.