kurnakovv / genericenvironment

GenericEnvironment is generic System.Environment class library.

Hello, Friend

🐱‍💻 About me:

I'm a middle backend developer, work in company tiburon-research

🖥 Hard skills:

Backend

Frontend

Tools

📈 Statistics:

📚 Books:

I have read:

I read:

📫 How to reach me:

genericenvironment's Issues

GenericEnvironment.GetEnvironmentVariableOrDefault

You can get docs from #15

CodeQL

Nuget action

Instruction

1. Create tag (1.0.1)
2. My github code will deploy in to nuget with this tag (1.0.1)

Add trigger on push for all action

Add trigger for all branches when push

GenericEnvironment.GetEnvironmentVariable

GenericEnvironment.GetEnvironmentVariable ReadMe file documentation

Fix codecov for main branch

Get environment variables

• List
• Array
• IEnumerable
• etc

Fix ref on GenericEnvironment.GetEnvironmentVariable in ReadMe

Fix this line
From DocsReadMe.md#GenericEnvironment.GetEnvironmentVariable to DocsReadMe.md#genericenvironmentgetenvironmentvariable

codecov

DocsReadMe.md

This file contains all method documentations

GenericEnvironment.GetEnvironmentVariableOrDefault

Description

Get environment variable or default(TType) (generic Environment.GetEnvironmentVariable).

Signature

TType GetEnvironmentVariableOrDefault<TType>(string name)

Use cases

• TType when environment variable was found.
• default(TType) when name is null.
• default(TType) when environment variable wasn't found.
• default(TType) when cannot convert environment variable to TType.
• default(TType) when a security error is detected.
• default(TType) when an arithmetic, casting, or conversion operation in a checked context results in an overflow.

Type Parameters

TType - Type of environment variable value.

Parameters

name - Name of environment variable

Returns

Environment variable or default(TType).

Code examples

// Setup
Environment.SetEnvironmentVariable("IntEnvironmentVariable", "12345"); // or from launchSettings.json

// Code
int firstResult = GenericEnvironment.GetEnvironmentVariableOrDefault<int>("IntEnvironmentVariable");
bool secondResult =  GenericEnvironment.GetEnvironmentVariableOrDefault<int>("InvalidEnvironmentVariableName");

// Output
// firstResult - 12345
// secondResult - 0

GenericEnvironment.TryGetEnvironmentVariable

Description

Try get environment variable (generic Environment.GetEnvironmentVariable).

Signature

bool TryGetEnvironmentVariable<TType>(string name, out TType value)

Use cases

• [true, value=TType] when environment variable was found.
• [false, value=default(TType)] when name is null.
• [false, value=default(TType)] when environment variable wasn't found.
• [false, value=default(TType)] when cannot convert environment variable to TType.
• [false, value=default(TType)] when a security error is detected.
• [false, value=default(TType)] when an arithmetic, casting, or conversion operation in a checked context results in an overflow.

Type Parameters

TType - Type of environment variable value.

Parameters

name - Name of environment variable
value - Environment variable value

Returns

true if environment variable was gotten by name; otherwise, false.

Code examples

// Setup
Environment.SetEnvironmentVariable("IntEnvironmentVariable", "12345"); // or from launchSettings.json

// Code
bool firstResult = GenericEnvironment.TryGetEnvironmentVariable("IntEnvironmentVariable", out int firstValue);
bool secondResult =  GenericEnvironment.TryGetEnvironmentVariable("InvalidEnvironmentVariableName", out int secondValue);

// Output
// [firstResult, firstValue] = [true, 12345]
// [secondResult, secondValue] = [false, 0]

GenericEnvironment.TryGetEnvironmentVariable

ReadMe file documentation

You can get documentation from #3

100% codecoverage

it's very strange why is not (because we have tests for all lines), but now we have 81%