Update README.md

This commit is contained in:
Stone-Red-Code
2021-05-04 15:24:59 +02:00
parent a4232e98f2
commit ad540a5a39
+119 -37
View File
@@ -5,45 +5,60 @@
## Install
### Package Manager
`Install-Package Stone_Red-C-Sharp-Utilities`
### .NET CLI
`dotnet add package Stone_Red-C-Sharp-Utilities`
### NuGet
https://www.nuget.org/packages/Stone_Red-C-Sharp-Utilities
<https://www.nuget.org/packages/Stone_Red-C-Sharp-Utilities>
## Namespaces
### Stone_Red_Utilities.ArrListExtentions
#### Methods:
* Print
#### Methods
* Print
* Description: Prints items of array
* Parameters: `this Array array`, `char delimiter`, `bool printToDebugConsole`
* Example usage:
```cs
string[] yourArray = { "str1", "str2", "str3" };
yourArray.Print(';');
```
* Output:
```
```text
str1; str2; str3
```
* Print\<T>
* Print\<T>
* Description: Prints items of list
* Parameters: `this List<T> list`, `char delimiter`, `bool printToDebugConsole`
* Example usage:
```cs
List<double> yourList = new() { 1.45, 6.24, 4.14 };
yourList.Print(';');
```
* Output:
```
```text
1.45; 6.24; 4.14
```
* PrintTable\<T>
* PrintTable\<T>
* Description: Creates and prints table from 2D array
* Parameters: `this T[,] array`, `TableStyle tableStyle`
* Example usage:
```cs
int[,] your2dArray =
{
@@ -53,8 +68,10 @@ https://www.nuget.org/packages/Stone_Red-C-Sharp-Utilities
};
your2dArray.PrintTable(TableStyle.Default);
```
* Output:
```
```text
-------------
| 1 | 2 | 3 |
-------------
@@ -65,38 +82,51 @@ https://www.nuget.org/packages/Stone_Red-C-Sharp-Utilities
```
### Stone_Red_Utilities.ConsoleExtentions
#### Methods:
* Write
#### Methods
* Write
* Description: Writes the text representation of the specified object to the standard output stream.
* Parameters: `object value`, `ConsoleColor color`
* Example usage:
```cs
ConsoleExt.Write("text in red", ConsoleColor.Red);
```
* Output:
```
```text
text in red
```
(Imagine that the text is actually red)
* WriteLine
* WriteLine
* Description: Writes the text representation of the specified object, followed by the current line terminator, to the standard output stream.
* Parameters: `object value`, `ConsoleColor color`
* Example usage:
```cs
ConsoleExt.WriteLine("text in green", ConsoleColor.Green);
```
* Output:
```
```text
text in green
```
(Imagine that the text is actually green)
### Stone_Red_Utilities.BoolExtentions
#### Methods:
* OneWayTrue
#### Methods
* OneWayTrue
* Description: Sets value to true if input is true. If input is false the value will not change.
* Parameters: `this ref bool bol`, `bool input`
* Example usage:
```cs
bool bol = false;
@@ -109,16 +139,20 @@ https://www.nuget.org/packages/Stone_Red-C-Sharp-Utilities
bol.OneWayTrue(false);
Console.WriteLine(bol);
```
* Output:
```
```text
False
True
True
```
* OneWayFalse
* OneWayFalse
* Description: Sets value to false if input is false. If input is true the value will not change.
* Parameters: `this ref bool bol`, `bool input`
* Example usage:
```cs
bool bol = true;
@@ -131,16 +165,20 @@ https://www.nuget.org/packages/Stone_Red-C-Sharp-Utilities
bol.OneWayFalse(true);
Console.WriteLine(bol);
```
* Output:
```
```text
True
False
False
```
* ToInt
* Description: Converts bool to int.
* Parameters: `this bool bol`
* Example usage:
```cs
bool bol1 = false;
bool bol2 = true;
@@ -151,15 +189,19 @@ https://www.nuget.org/packages/Stone_Red-C-Sharp-Utilities
Console.WriteLine(i);
Console.WriteLine(j);
```
* Output:
```
```text
0
1
```
* FromInt
* Description: Converts int to bool.
* Parameters: `this ref bool bol`, `int input`
* Example usage:
```cs
bool bol1;
bool bol2;
@@ -170,18 +212,23 @@ https://www.nuget.org/packages/Stone_Red-C-Sharp-Utilities
Console.WriteLine(bol1);
Console.WriteLine(bol2);
```
* Output:
```
```text
false
true
```
### Stone_Red_Utilities.StringExtentions
#### Methods
* EqualsIgnoreCase
* EqualsIgnoreCase
* Description: Determines whether this instance and another specified string object have the same value regardless of upper and lower case.
* Parameters: `this string str`, `string value`
* Example usage:
```cs
string str1 = "BIG";
string str2 = "big";
@@ -189,15 +236,20 @@ https://www.nuget.org/packages/Stone_Red-C-Sharp-Utilities
bool match = str1.EqualsIgnoreCase(str2);
Console.WriteLine(match);
```
* Output:
```
```text
True
```
* EqualsIgnoreSpaces
* EqualsIgnoreSpaces
* Description: Determines whether this instance and another specified string object have the same value regardless of spaces.
* Parameters: `this string str`, `string value`
* Example usage:
```cs
string str1 = "space";
string str2 = " s p a c e ";
@@ -206,14 +258,18 @@ https://www.nuget.org/packages/Stone_Red-C-Sharp-Utilities
Console.WriteLine(match);
```
* Output:
```
```text
True
```
* EqualsIgnoreSpacesAndCase
* EqualsIgnoreSpacesAndCase
* Description: Determines whether this instance and another specified string object have the same value regardless of upper and lower case and spaces.
* Parameters: `this string str`, `string value`
* Example usage:
```cs
string str1 = "BIG space";
string str2 = "big s p a c e ";
@@ -221,72 +277,98 @@ https://www.nuget.org/packages/Stone_Red-C-Sharp-Utilities
bool match = str1.EqualsIgnoreSpacesAndCase(str2);
Console.WriteLine(match);
```
* Output:
```
```text
True
```
* ToFileName
* ToFileName
* Description: Determines whether this instance and another specified string object have the same value regardless of upper and lower case and spaces.
* Parameters: `this string str`, `string value`
* Example usage:
```cs
string str = "*n*/ /äme";
string fileName = str.ToFileName();
Console.WriteLine(fileName);
```
* Output:
```
```text
name
```
* ToPath
* ToPath
* Description: Determines whether this instance and another specified string object have the same value regardless of upper and lower case and spaces.
* Parameters: `this string str`, `string value`
* Example usage:
```cs
string str = "C://goöd /päth";
string fileName = str.ToPath();
Console.WriteLine(fileName);
```
* Output:
```
```text
C://good/path
```
### Stone_Red_Utilities.Logging
#### Constructor:
* Logger
* Initializes the logger with the default format and a file path.
#### Constructor
* Logger
* Description: Initializes the logger with the default format and a file path.
* Parameters: `LogTarget logTarg`, `string file`, `string defaultFormat`
* Example usage:
```cs
Logger logger = new Logger(LogTarget.ConsoleAndFile, "events.log", "{<dateTime>:HH:mm:ss} | {<level>,-7} | {<source>,-15} | {<message>}");
```
#### Methods:
* Log
#### Methods
* Log
* Description: Log the message to the specified output
* Parameters: `string message`, `string source`, `LogSeverity logSeverity`
* Example usage:
```cs
logger.Log("something happend", "Update manager", LogSeverity.Error);
```
* Output (Depends on the specified log format):
```
```text
19:15:14 | Error | Update manager | something happend
```
* LogIf
* Description: Log the message to the specified output if the condition is met
* Parameters: `bool condition`, `string message`, `string source`, `LogSeverity logSeverity`
* Example usage:
```cs
logger.Log(IsValid(),"something is invalid", "Update manager", LogSeverity.Error);
```
* Output (Depends on the specified log format):
```
```text
19:15:14 | Error | Update manager | something happend
```
* ClearLogFile
* Description: Clears the log file
* Example usage:
```cs
logger.ClearLogFile();
```