SCM.SwissArmyKnife 0.0.0-preview.0.28

SwissArmyKnife

This is a project full of utility methods that can be used across multiple projects.
The code is:

• Thoroughly documented
• Thoroughly tested
• Methods that are side-effect free are marked as [Pure]

Installation

This library can be installed from Nuget or Github Packages.

Nuget

You can install it from nuget by running dotnet add package SwissArmyKnife

Github

If you are developing the library or want the latest packages built from the main branch, you can get them from Github packages.

1. Add a nuget.config file to the root of your project.

<?xml version="1.0" encoding="utf-8"?>
<configuration>
    <packageSources>
        <clear />
        <add key="github" value="https://nuget.pkg.github.com/SCADAMINDS/index.json" />
    </packageSources>
    <packageSourceCredentials>
        <github>
            <add key="Username" value="USERNAME" />
            <add key="ClearTextPassword" value="TOKEN" />
        </github>
    </packageSourceCredentials>
</configuration>

2. Replace USERNAME with your Github username and TOKEN with a personal access token.
3. Add the package: dotnet add package SwissArmyKnife --version {VERSION} --prerelease

SwissArmyKnife.Extensions

A bunch of handy extension methods that you'll probably like to use! Examples:

// ------------- Dictionary.GetOr
myDictionary.GetOr("nonExistingKey", () => "myFallbackValue");


// ------------- Task.Select()
var enumerableTask = Task.FromResult(new int[]{1,2});

// Select to transform multiple values
// Alternative to (await enumerableTask).Select(i => i + 1)
await enumerableTask.Select(i => i + 1); // Returns [2,3]


// ------------- object.Yield
// Produce an Enumerable out of an item
int myItem = 3;

// Type: IEnumerable<int>
var myEnumerable = myItem.Yield();

// ------------- HttpClient.GetAsJsonAsync()
var client = new HttpClient();

var url = "http://www.some-url-that-produces-json.com"

// Gets URL and serializes model to MyResponseModel. On error prints http response
var await response = client.GetAsJsonAsync<MyResponseModel>(url)

And many more!

Documentation

We automatically build the documentation based on some written docs and the source code. You can find the main page of the generated documentation here. It is automatically published from the main branch, so it might be slightly ahead of the current Nuget release.