Utils.EnvironmentManager 2.0.0

Utils.EnvironmentManager

The EnvironmentManager namespace now provides a class EnvManager that uses AutoMapper package, for retrieving environment variable values and performing type conversions.

Note This documentation assumes a basic understanding of AutoMapper library. AutoMapper docs

Initialization

To initialize the EnvManager, a configuration from AutoMapper is required:

var manager = EnvManager.CreateWithDefaultConfiguration();

Methods

GetEnvironmentValue

The method retrieves the value of the specified environment variable and converts it to the desired type using AutoMapper.

Signature:

public object GetEnvironmentValue(Type type, string variableName, bool raiseException = false)

Parameters:

• type (Type): The type to which the environment variable's value should be converted.
• variableName (string): The name of the environment variable.
• raiseException (bool, optional): Specifies whether to raise an exception if the environment variable is null or empty, or when the conversion fails. Defaults to false.

Returns:

• object: The converted value of the environment variable.

GetEnvironmentValue<T>

This method retrieves the value of the specified environment variable and converts it to the specified type T.

Signature:

public T GetEnvironmentValue<T>(string variableName, bool raiseException = false)

Parameters:

• variableName (string): The name of the environment variable.
• raiseException (bool, optional): Specifies whether to raise an exception if the environment variable is null or empty, or when the conversion fails. Defaults to false.

Returns:

• T: The converted value of the environment variable.

Adding Custom Mappings

The library now uses AutoMapper for type conversions. Therefore, to add custom type conversions, you can utilize the EnvManagerMappingConfigurator class.

Example:

var config = new EnvManagerMappingConfigurator()
    .CreateMapFor(x => DateTime.ParseExact(x, "dd-MM-yyyy HH:mm", CultureInfo.InvariantCulture))
    .CreateMapFor(x => Enum.Parse<MyEnumeration>(x, true))
    .Build();

var manager = new EnvManager(config);

DateTime customDateFormat = manager.GetEnvironmentValue<DateTime>("CUSTOM_DATE_FORMAT");

In this example, a custom date format is added using the CreateMapFor method. Also in this example adding mapping for a MyEnumeration enum. Once the custom mappings are added, the configuration is built and passed to the EnvManager.