@ortha/server-platform-env

Typed environment variable parsers with validation. Provides a set of helper functions to read, parse, and validate environment variables with type safety and sensible defaults.

Installation

Internal monorepo dependency — import directly:

import {
    envString,
    envInt,
    envBool,
    envPort,
    envEnum
} from '@ortha/server-platform-env';

Usage

import {
    envString,
    envInt,
    envBool,
    envPort,
    envEnum
} from '@ortha/server-platform-env';

const config = {
    host: envString('HOST', '0.0.0.0'),
    port: envPort('PORT', 3000),
    logLevel: envEnum('LOG_LEVEL', ['info', 'debug', 'warn', 'error'], 'info'),
    dbHost: envString('DB_HOST', 'localhost'),
    dbPort: envInt('DB_PORT', 5432),
    dbLogging: envBool('DB_LOGGING', false)
};

API Reference

| Export | Kind | Description | | ------------- | -------- | ------------------------------------------------------------- | | envString() | function | Read string env var — required if no default provided | | envInt() | function | Read and parse integer env var — throws on non-numeric values | | envBool() | function | Read boolean env var — accepts "true" / "false" strings | | envPort() | function | Read port number with range validation (1–65535) | | envEnum() | function | Read env var constrained to an allowed set of values |

Function Signatures

envString(name: string, defaultValue?: string): string;
envInt(name: string, defaultValue?: number): number;
envBool(name: string, defaultValue?: boolean): boolean;
envPort(name: string, defaultValue?: number): number;
envEnum<T extends string>(name: string, allowed: T[], defaultValue?: T): T;

All functions throw if the environment variable is missing and no default is provided.

Internal Structure

src/lib/
└── env/index.ts    # All env helper functions

Building

nx build server-platform-env