Saltar al contenido principal
lib-commons-js es una biblioteca de Node.js basada en TypeScript desarrollada por Lerian Studio. Reúne bloques de construcción comunes de nuestros proyectos, haciéndolos reutilizables en diferentes aplicaciones en un entorno JavaScript. Funciona tanto en proyectos frontend como backend de Node.js. El objetivo es ayudarle a escribir menos código repetitivo, mantener las cosas consistentes y reutilizar lo que ya funciona — todo de manera modular. Ya sea que esté construyendo un plugin, un servicio o una integración de UI, esta biblioteca le ayuda a moverse más rápido y evitar sorpresas en el camino.

​
Cuándo usar

Use lib-commons-js siempre que necesite lógica compartida que ha sido probada en el ecosistema de Lerian. Es especialmente útil cuando desea:
  • Integrar con Midaz.
  • Compartir modelos de datos entre servicios.
  • Reducir código repetitivo en proyectos TypeScript.

​
Características clave

  • Arquitectura modular: Importe solo los componentes que necesite para mantener su proyecto limpio y enfocado.
  • Soporte de TypeScript: Escrito en TypeScript desde el principio para una mejor experiencia de desarrollador y seguridad de tipos.
  • Utilidades centrales: Ayudantes listos para usar para registro, manejo de contexto, gestión de errores y procesamiento de transacciones.
  • Modelos compartidos: Modelos de datos centralizados que aseguran consistencia en todos los proyectos.
  • Lógica de negocio: Reglas y patrones comunes usados por múltiples servicios de Midaz, envueltos y listos para usar.

​
Estructura del repositorio

El repositorio está organizado para claridad y uso modular:
  • commons/: Módulos centrales y utilidades.
  • Archivos de configuración: Incluye .eslintrc.js, .prettierrc y tsconfig.json para hacer cumplir la calidad del código.
  • Gestión de paquetes: Gestionado a través de package.json y package-lock.json.
  • Integración continua: Versiones automatizadas configuradas con flujos de trabajo .github/ y .releaserc.yml.

​
Comenzando

​
Requisitos

Necesitará Node.js v23 o posterior para usar esta biblioteca.

​
1. Instalar la biblioteca

npm install @lerian/lib-commons-js

​
2. Agregar la biblioteca a su proyecto

Para usar lib-commons-js, importe el subpaquete relevante en el archivo donde lo necesite. Las funciones estarán disponibles a través de la importación nombrada: 
import { transactions as lib } from '@lerian/lib-commons-js'

​
Contribuir

Damos la bienvenida a las contribuciones. Si ha escrito lógica que podría beneficiar a otros servicios, traigámosla a lib-commons-js. Asegúrese de que su código siga nuestros estándares e incluya cobertura de pruebas.

​
Licencia

  • Apache 2.0 - consulte la página de LICENCIA para más detalles.
⌘I