Tipado seguro en TypeScript para configuración de aplicaciones

Curso de NestJS: Programación Modular, Documentación con Swagger y Deploy

Contenido del curso

Módulos de NestJS

Configuración de entornos

Documentación

Deploy

Próximos pasos

17
Inyección de Dependencias en APIs con Heroku
01:04 min

Tomar examen

Cursos Empresas Blog Live Conf Eventos Precios

0:0010:37

Tipado seguro en TypeScript para configuración de aplicaciones

Curso de NestJS: Programación Modular, Documentación con Swagger y Deploy

Clase 11 de 17

Clase 11 / 17

Recursos

Cuando un proyecto crece y el equipo se amplía, los errores de escritura en las variables de entorno se convierten en una fuente silenciosa de bugs en producción. Un simple API_HEI en lugar de API_KEY puede devolver un undefined, impedir la conexión a una base de datos y consumir horas de depuración sin que nadie entienda qué salió mal. Afortunadamente, TypeScript y NestJS ofrecen herramientas para blindar la configuración con tipado seguro y eliminar ese riesgo desde el momento de compilación.

¿Por qué los errores de typo en variables de entorno son tan peligrosos?

Cuando se accede a una variable de entorno mediante un string directo —por ejemplo process.env.API_HEI— el compilador no emite ninguna advertencia [0:20]. El valor simplemente será undefined o null, y el error solo se manifestará en tiempo de ejecución, a veces ya en producción.

No existe autocompletado que avise del nombre correcto.
Sin pruebas unitarias, el fallo pasa desapercibido fácilmente.
En equipos grandes, cada desarrollador puede digitar la variable de forma distinta.

La solución es dejar de confiar en strings sueltos y crear una capa de configuración tipada que TypeScript pueda validar.

¿Cómo crear un archivo de configuración tipado en NestJS?

El primer paso es generar un archivo llamado config.ts junto al directorio de environments [1:30]. Dentro de él se importa registerAs desde @nestjs/config y se exporta una función con nombre:

typescript import { registerAs } from '@nestjs/config';

export default registerAs('config', () => ({ apiKey: process.env.API_KEY, database: { name: process.env.DATABASE_NAME, port: process.env.DATABASE_PORT, }, }));

El concepto de registerAs permite registrar un espacio de nombres (namespace) para la configuración. Esto aporta dos ventajas claras:

Agrupación de variables: a diferencia de un archivo .env, donde todo es una lista plana, aquí se pueden anidar propiedades relacionadas dentro de un objeto como database [2:25].
Tipado seguro: TypeScript conoce la forma exacta del objeto que retorna la función, así que cualquier error de escritura se detecta antes de ejecutar.

¿Cómo se inyecta la configuración tipada en un servicio?

En el servicio donde se necesitan las variables, se reemplaza el uso tradicional de ConfigService por la inyección directa del namespace tipado [4:00]:

typescript import { Inject, Injectable } from '@nestjs/common'; import config from './config'; import { ConfigType } from '@nestjs/config';

@Injectable() export class AppService { constructor( @Inject(config.KEY) private configService: ConfigType<typeof config>, ) {} }

El tipo ConfigType extrae la forma del objeto registrado con registerAs. De este modo, al escribir this.configService.apiKey o this.configService.database.name, el editor muestra autocompletado y marca cualquier propiedad inexistente como error de compilación [4:55].

¿Qué configuración se necesita en el módulo principal?

Para que la inyección de dependencias funcione, es necesario cargar el archivo de configuración en el AppModule [5:50]:

typescript import { Module } from '@nestjs/common'; import { ConfigModule } from '@nestjs/config'; import config from './config';

@Module({ imports: [ ConfigModule.forRoot({ load: [config], }), ], }) export class AppModule {}

La propiedad load recibe un arreglo porque pueden existir múltiples archivos de configuración. NestJS los lee, resuelve las variables desde el .env correspondiente y las pone disponibles con tipado completo.

¿Cuándo conviene aplicar tipado seguro a la configuración?

Si el proyecto es pequeño y el equipo tiene total control, usar configService.get('API_KEY') con un string puede ser suficiente [6:45]. Sin embargo, en software de gran escala o equipos numerosos, tipar la configuración se considera una buena práctica porque:

Se detectan errores en tiempo de compilación, no en producción.
El autocompletado acelera el desarrollo y reduce la fricción.
La agrupación de variables mejora la legibilidad del código.

La decisión final depende del contexto del equipo, pero blindar las variables de entorno con TypeScript es una inversión que se paga sola cada vez que se evita un bug silencioso. ¿Ya estás tipando tu configuración o prefieres el enfoque clásico? Comparte tu experiencia.

Walter Lensinas

Hace 5 años

Esto lo venia haciendo con la dependencia dotenv en nodejs puro y duro jaja

Los apuntes de Angel son buenisimos! Le agrego lo siguiente

Una vez terminado el config.ts hay que importarlo en el app.module.ts usando load:

import config from './config'; //importarlo

@Module({
  imports: [
    ConfigModule.forRoot({
      envFilePath: environments[process.env.NODE_ENV] || '.env',
      load: [config],
      isGlobal: true,
    }),
	...
     ],
})

Cambiamos el ConfigService por ConfigType en app.service.ts e importamos config. Luego lo inyectamos en el contructor.

import { Injectable, Inject } from '@nestjs/common';
import { ConfigType } from '@nestjs/config';
import config from './config';

@Injectable()
export class AppService {
  constructor(
    //@Inject('API_KEY') private apiKey: string,
    @Inject('TASKS') private tasks: any[],
    @Inject(config.KEY) private configService: ConfigType<typeof config>,
  ) {}
  getHello(): any {
    const apiKey = this.configService.apiKey;
    const dbName = this.configService.database.name;
    const dbPort = this.configService.database.port;
    return `api: ${apiKey} db: ${dbName} db_port: ${dbPort}`;
    //return this.tasks;
  }
}

Comentarios (14)14 comentarios

Ángel David Roque Ayala

Cristhian Arturo Tacuri Rosales

Nicolas Molina

Profesor

Daniel Cueto

Hace un año

Daniel Rodriguez

Hace 3 años

Renato Renzo Luna Herrera

Pablo Antipan Quiñenao

Cristian Esquivel

Jefred Bedoya

Hace 3 meses

TIQAL SAS

Geovanni Labastida Vázquez

Jorge Andres Perez Guzman

Hace 4 años

Jefferson Rivera

Rogelio Samuel Moreno Corrales

Jonnathan Ramiro Juma Jara

Naldo Duran

Módulos de NestJS

Programación Modular y Deployment en Nest GS

Encapsulación de Lógica en Módulos con NestJS

Programación Modular en NestJS: Controladores y Entidades

Interacción entre Módulos en NestJS: Servicios y Controladores

Inyección de Dependencias en Arquitectura de Software

Tipos de Providers en NestJS: Use Class y Use Value

useFactory

Uso de Módulos Globales en NestJS para Inyecciones Compartidas

Configuración de entornos

Configuración y uso de variables de entorno en NestJS

Configuración de Ambientes con Archivos .env en Node.js

Tipado seguro en TypeScript para configuración de aplicaciones

Validación de Variables de Entorno con Joi en Node.js

Documentación

Documentación automática de APIs con NestJS y Swagger

Documentación de API con NestJS y Swagger

Deploy

Deployment de Aplicaciones Node.js en Heroku

Deployment de Aplicaciones en Heroku: Configuración y Solución de Errores

Próximos pasos

Inyección de Dependencias en APIs con Heroku

Tipado seguro en TypeScript para configuración de aplicaciones

Progreso del curso

Módulos de NestJS

Configuración de entornos

Documentación

Deploy

Próximos pasos

Recursos

Recursos