Skip to content

Configuration Engine

The config module parses, validates, and manages gateway runtime options. It resolves file paths, performs schema validation with detailed diagnostics, substitutes environment variables via string interpolation, and auto-tunes worker threads and concurrency thresholds according to host CPU specifications. This layer guarantees configuration soundness prior to server socket binding.

SymbolKindSignaturePurpose
ConfigOptimizationinterfaceinterface ConfigOptimizationConfiguration optimization recommendation
LoadPatterninterfaceinterface LoadPatternLoad pattern analysis
AutoTunerConfiginterfaceinterface AutoTunerConfigAuto-tuner configuration
AutoTunerclassclass AutoTunerAuto-Tuner class
InterpolationErrorclassclass InterpolationError extends ErrorInterpolation error for tracking issues during variable replacement
InterpolationOptionsinterfaceinterface InterpolationOptionsInterpolation options
interpolateStringfunctionfunction interpolateString(Interpolate environment variables in a string value @param value - String value that may contain ${ENV_VAR} or ${ENV_VA
interpolateConfigfunctionfunction interpolateConfig<T>(Recursively interpolate environment variables in a configuration object @param config - Configuration object @param opt
extractEnvVarsfunctionfunction extractEnvVars(config: unknown): Set<string>Extract all environment variable references from a configuration object Useful for documentation and validation @param
validateEnvVarsfunctionfunction validateEnvVars(Validate that all required environment variables are set @param config - Configuration object @param env - Environment
ConfigLoaderclassclass ConfigLoaderClass export for ConfigLoader.
createConfigLoaderfunctionfunction createConfigLoader(options:Function export for createConfigLoader.
OpenApiRouteinterfaceinterface OpenApiRouteInterface export for OpenApiRoute.
OpenApiRouteOptionsinterfaceinterface OpenApiRouteOptionsInterface export for OpenApiRouteOptions.
routesFromOpenApifunctionfunction routesFromOpenApi(Function export for routesFromOpenApi.
ConfigValidatorclassclass ConfigValidatorClass export for ConfigValidator.
configValidatorconstconst configValidator: ConfigValidator = new ConfigValidator()Const export for configValidator.
VersionComparisonenumenum VersionComparisonVersion comparison result
ConfigMigrationtypetype ConfigMigration = (config: Record<string, unknown>) => Record<string, unknown>Configuration migration function
VersionInfointerfaceinterface VersionInfoConfiguration version info
parseVersionfunctionfunction parseVersion(version: string): { major: number; minor: number; patch: number }Parse semantic version string into components
compareVersionsfunctionfunction compareVersions(v1: string, v2: string): VersionComparisonCompare two semantic versions
isCompatibleVersionfunctionfunction isCompatibleVersion(configVersion: string, currentVersion: string): booleanCheck if version is compatible (within 1 major version)
ConfigVersionManagerclassclass ConfigVersionManagerConfiguration version manager
configVersionManagerconstconst configVersionManager = new ConfigVersionManager('1.2.0')Default configuration version manager instance

Reads JSON or JS configuration files and recursively validates required route schemas.

Substitutes ${ENV_VAR:-fallback} patterns securely without leaking environment contents.

Inspects available memory and hardware concurrency to calculate optimal Keep-Alive pool sizes.

  • src/config/auto-tuner.ts
  • src/config/interpolation.ts
  • src/config/loader.ts
  • src/config/openapi-routes.ts
  • src/config/validator.ts
  • src/config/versioning.ts