NamespaceSystemLibrary.Common.Framework

Standard class for environmental configurations read from environmentConfig.json if exists

If you've added more properties to environmentConfig.json than just the 'Name' you'd have to inherit 'EnvironmentConfig<YourClass>' and use that instead

Remarks
X

See the documentation for 'Name' property on class 'EnvironmentConfig<>' for more details regarding transformations

EnvironmentConfig

public class EnvironmentConfig : EnvironmentConfig<EnvironmentConfig, EnvironmentName>

Inheritance
object
Config<EnvironmentConfig>
EnvironmentConfig<EnvironmentConfig, EnvironmentName>
EnvironmentConfig
Inherited Members
Examples
Arguments

Fields

Returns the application's root folder full path.

Does not end with a slash.

If the folder is 'bin' or inside it, the method will traverse up and return the parent folder of the 'bin' folder. Exceptions is if assembly ends in Tests for test projects, then 'up-traversal out of bin' is skipped

Remarks
X

See the documentation for 'Name' property on class 'EnvironmentConfig<>' for more details regarding transformations

public static readonly string ContentRootPath

Field Value
Type Description
string

Properties

Returns true if both IsTest and IsProd are false.

Remarks
X

See the documentation for 'Name' property on class 'EnvironmentConfig<>' for more details regarding transformations

public static bool IsLocal { get; }

Property Value
Type Description
bool

Returns true if the environment is set to 'prod' or 'production', otherwise false.

Remarks
X

See the documentation for 'Name' property on class 'EnvironmentConfig<>' for more details regarding transformations

public static bool IsProd { get; }

Property Value
Type Description
bool

Returns true if both IsLocal and IsProd are false

Note: returns true for Test, PreProduction, Sandbox, Stage, QA and more...

Remarks
X

See the documentation for 'Name' property on class 'EnvironmentConfig<>' for more details regarding transformations

public static bool IsTest { get; }

Property Value
Type Description
bool

Extension Methods

ObjectExtensions.Json(object, bool)
ObjectExtensions.Json(object, JsonSerializerOptions, bool, params JsonConverter[])
ObjectExtensions.Json(object, params JsonConverter[])
ObjectExtensions.Xml(object)

}