xTaskjs 1.0 ya está disponible: cuentas por rol, documentación y una interfaz personalizable.

EN ES
Iniciar sesión Registrarse

Paquetes

@xtaskjs/config

Typed, fail-fast environment configuration with Zod-powered schema validation.

Volver al catálogo Ver código fuente
npm install @xtaskjs/config zod Ruta del paquete: packages/config

Resumen

Qué controla este paquete en el runtime

Config centralizes environment loading and validation so applications fail fast when required variables are missing or invalid. It exposes a typed ConfigService through DI and supports env-file loading plus optional prefixed variable mapping.

Qué ofrece

  • ConfigModule.register() and ConfigModule.registerAsync() provide synchronous and factory-driven bootstrap flows.
  • Schema validation runs before traffic is served, so invalid env state fails startup early.
  • InjectConfigService() and getConfigService() expose typed values inside DI-managed services.
  • Prefix mapping can resolve logical keys from prefixed variables such as DB_HOST and DB_PORT.

Cómo encaja

  • Used across upstream samples to register NODE_ENV, PORT, and runtime tuning variables before CreateApplication().
  • Fits naturally with @xtaskjs/core lifecycle because config validation runs before route handling begins.
  • Pairs with @xtaskjs/security, @xtaskjs/typeorm, and other modules to centralize credentials and endpoint settings.

Mapa de uso

Qué peso tiene este paquete dentro del runtime

Arranque

5/5

Inyección de dependencias

4/5

Configuration

5/5

Operaciones

4/5

Integraciones

5/5

Flujo del paquete

Cómo atraviesa este paquete las fases del runtime de xtaskjs

Antes del arranque

Register schema, env files, and optional prefix settings so required variables are known before other integrations initialize.

Durante CreateApplication()

Config validation runs early, then ConfigService and related lifecycle tokens are published into the container for DI-managed classes.

Durante app.close()

The config lifecycle releases in-memory runtime state while environment values remain immutable process inputs.

Superficie API

Exports representativos del paquete original

Uso

Flujo típico de adopción

1. Register a schema

Use ConfigModule.register() with a Zod schema to define the canonical environment contract for your app.

2. Load env files safely

Set envFiles and optional prefix mapping so local and deployed environments resolve variables consistently.

3. Inject typed config

Use InjectConfigService() in services and startup modules instead of reading process.env directly in business code.

Ejemplo

Fragmento de referencia

Schema-first configuration module
import { z } from "zod";
import { ConfigModule, InjectConfigService, type ConfigService } from "@xtaskjs/config";

const AppConfigSchema = z.object({
  NODE_ENV: z.enum(["development", "test", "production"]).default("development"),
  PORT: z.coerce.number().int().positive().default(3000),
  DATABASE_URL: z.string().url(),
});

ConfigModule.register({
  schema: AppConfigSchema,
  envFiles: [".env", ".env.local"],
});

class AppSettingsService {
  @InjectConfigService()
  private readonly config!: ConfigService<z.infer<typeof AppConfigSchema>>;

  getPort() {
    return this.config.get("PORT");
  }
}

Ejemplos

Ejemplos oficiales para revisar después

Ejemplos de referencia: 01-new_app, 03-fastify_app, 06-security_app, 09-internationalization_app, 18-value_objects_app, 26-bots_app, 27-bots_webhook_security_app