Esta dependencia está pensada para ser utilizada en NestJs Starter, o cualquier proyecto que utilice una configuración centralizada, siguiendo la misma arquitectura del starter.

Glosario

• 🥳 Demo
• 📝 Requerimientos básicos
• 🛠️ Instalar dependencia
• ⚙️ Configuración
• 📤 Commits
• 📄 Changelog
• 📜 License MIT

📝 Requerimientos básicos

• NestJs Starter
• Node.js v14.15.4 or higher (Download)
• NPM v6.14.10 or higher
• NestJS v8.2.0 or higher (Documentación)

🛠️ Instalar dependencia

npm install @tresdoce/nestjs-health

⚙️ Configuración

Para excluir los paths /liveness y /readiness hay que ajustar el setGlobalPrefix agregando los options exclude que exporta la dependencia.

// .src/main.ts

import { controllersExcludes } from '@tresdoce/nestjs-health';

app.setGlobalPrefix(`${server.context}`, {
  exclude: [...controllersExcludes],
});

// .src/app.module.ts
import { HealthModule } from '@tresdoce/nestjs-health';
import { config } from './config';

@Module({
    ...,
    imports: [
        HealthModule.register(config()),
    ],
    ...,
})
export class AppModule {}

📤 Commits

Para los mensajes de commits se toma como referencia conventional commits.

<type>[optional scope]: <description>

[optional body]

[optional footer]

• type: chore, docs, feat, fix, refactor (más comunes)
• scope: indica la página, componente, funcionalidad
• description: comienza en minúsculas y no debe superar los 72 caracteres.

📄 Changelog

All notable changes to this package will be documented in Changelog file.