English

Русский

English

Русский

Appearance

Connectum API Reference / @connectum/core / safeParseEnvConfig

Function: safeParseEnvConfig() ​

safeParseEnvConfig(env?): ZodSafeParseResult<{ GRACEFUL_SHUTDOWN_ENABLED: boolean; GRACEFUL_SHUTDOWN_TIMEOUT_MS: number; HTTP_HEALTH_ENABLED: boolean; HTTP_HEALTH_PATH: string; LISTEN: string; LOG_BACKEND: "otel" | "pino" | "console"; LOG_FORMAT: "json" | "pretty"; LOG_LEVEL: "error" | "debug" | "info" | "warn"; NODE_ENV: "test" | "production" | "development"; OTEL_EXPORTER_OTLP_ENDPOINT?: string; OTEL_SERVICE_NAME?: string; PORT: number; }>

Defined in: packages/core/src/config/envSchema.ts:162

Safely parse environment configuration (returns result object)

Parameters ​

env? ​

Record<string, string | undefined> = process.env

Returns ​

ZodSafeParseResult<{ GRACEFUL_SHUTDOWN_ENABLED: boolean; GRACEFUL_SHUTDOWN_TIMEOUT_MS: number; HTTP_HEALTH_ENABLED: boolean; HTTP_HEALTH_PATH: string; LISTEN: string; LOG_BACKEND: "otel" | "pino" | "console"; LOG_FORMAT: "json" | "pretty"; LOG_LEVEL: "error" | "debug" | "info" | "warn"; NODE_ENV: "test" | "production" | "development"; OTEL_EXPORTER_OTLP_ENDPOINT?: string; OTEL_SERVICE_NAME?: string; PORT: number; }>

Example ​

typescript
const result = safeParseEnvConfig();
if (result.success) {
  console.log(result.data.PORT);
} else {
  console.error(result.error.format());
}