@spraxium/env

@spraxium/env provides typed, decorator-based environment variable validation for Spraxium bots. You define a configuration class, annotate each property with @Env, and pass it to EnvModule.forRoot at the application root. If any required variable is missing or fails type coercion, the process prints a formatted error table and exits before the bot connects to Discord, preventing the hard-to-debug runtime failures that come from missing configuration.

The package supports string, number, boolean, and enum coercions out of the box, optional fields with default values, and secret masking so that sensitive values are never printed in full to the console or logs. The validated configuration class is registered as an injectable provider, so any service in the application can declare it as a constructor dependency and receive the fully typed, pre-validated config object.

Installation

npm install @spraxium/env

Usage

import { EnvConfig, Env } from '@spraxium/env';

@EnvConfig()
export class AppConfig {
  @Env('DISCORD_TOKEN', { secret: true })
  token: string;

  @Env('COMMAND_PREFIX', { default: '!' })
  prefix: string;

  @Env('DEBUG', { default: false })
  debug: boolean;
}

import { Module } from '@spraxium/common';
import { EnvModule } from '@spraxium/env';
import { AppConfig } from './app.config';

@Module({
  imports: [EnvModule.forRoot(AppConfig)],
})
export class AppModule {}

Links

npm · GitHub · Documentation

License

Apache 2.0