ConfigModule

  
class ConfigModule {
  static envVariablesLoaded
  static forRoot(options: ConfigModuleOptions = {}): DynamicModule
  static forFeature(config: ConfigFactory<ConfigObject>): DynamicModule
}

Static properties

Property Description
static envVariablesLoaded Read-only.

This promise resolves when "dotenv" completes loading environment variables. When "ignoreEnvFile" is set to true, then it will resolve immediately after the "ConfigModule#forRoot" method is called.

Static methods

forRoot()

Loads process environment variables depending on the "ignoreEnvFile" flag and "envFilePath" value. Also, registers custom configurations globally.


static forRoot(options: ConfigModuleOptions = {}): DynamicModule

Parameters

Option Type Description
options ConfigModuleOptions

Optional. Default is {}.

Returns

DynamicModule

forFeature()

Registers configuration object (partial registration).


static forFeature(config: ConfigFactory<ConfigObject>): DynamicModule

Parameters

Option Type Description
config ConfigFactory

Returns

DynamicModule