VinisLab.EnvironmentVariables 24.11.18.927

dotnet add package VinisLab.EnvironmentVariables --version 24.11.18.927
                    
NuGet\Install-Package VinisLab.EnvironmentVariables -Version 24.11.18.927
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="VinisLab.EnvironmentVariables" Version="24.11.18.927" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="VinisLab.EnvironmentVariables" Version="24.11.18.927" />
                    
Directory.Packages.props
<PackageReference Include="VinisLab.EnvironmentVariables" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add VinisLab.EnvironmentVariables --version 24.11.18.927
                    
#r "nuget: VinisLab.EnvironmentVariables, 24.11.18.927"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package VinisLab.EnvironmentVariables@24.11.18.927
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=VinisLab.EnvironmentVariables&version=24.11.18.927
                    
Install as a Cake Addin
#tool nuget:?package=VinisLab.EnvironmentVariables&version=24.11.18.927
                    
Install as a Cake Tool

VinisLab.EnvironmentVariables

Abstraction of GetEnvironmentVariable Improving testability and predictable behaviour.

The package introduces IEvironmentVariables which can be mocked during tests. It also produces a well defined EnvironmentVariableNotFoundException for better error handling.

The internal implementation of GetEnvironmentVariable() implements an hierarchical Variable lookup starting with in Process Variables, User Variables and later Machine Variables.

Hot to use it?

  • Without Dependency Injection

When services are starting there is no dependency injection container available so the package provides a way to create a context that can be used during initialization:

using VinisLab.EnvironmentVariables;

public Program
{
    public static async Task Main(string[] args)
    {
        var envVarContext = EnvironmentVariablesContext.CreateStaticContext();

        var yourVar = envVarContext.GetEnvironmentVariable("YOUR_ENV_VAR_NAME");
    }
}
  • With Dependency Injection

The package provides an extension method to inject IEnvironmentVariables into your DI container

using VinisLab.EnvironmentVariables;
using VinisLab.EnvironmentVariables.DependencyInjection;

public Program
{
    public static async Task Main(string[] args)
    {
        var builder = WebApplication.CreateBuilder(args);
        builder.Services.InjectEnvironmentVariablesAbstraction();
        var app = builder.Build();
    }
}

public class MyExampleController(IEnvironmentVariables environmentVariables) : Controller
{
    public void MyControllerEndpoint()
    {
        var yourVar = environmentVariables.GetEnvironmentVariable("YOUR_ENV_VAR_NAME");
    }
}

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
24.11.18.927 1,590 11/18/2024
24.10.15.1054 625 10/15/2024
24.10.15.1018 182 10/15/2024
1.0.0 178 10/15/2024