Armala.FConfig 22.12.30.1030

There is a newer version of this package available.
See the version list below for details.
dotnet add package Armala.FConfig --version 22.12.30.1030
NuGet\Install-Package Armala.FConfig -Version 22.12.30.1030
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="Armala.FConfig" Version="22.12.30.1030" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Armala.FConfig --version 22.12.30.1030
#r "nuget: Armala.FConfig, 22.12.30.1030"
#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.
// Install Armala.FConfig as a Cake Addin
#addin nuget:?package=Armala.FConfig&version=22.12.30.1030

// Install Armala.FConfig as a Cake Tool
#tool nuget:?package=Armala.FConfig&version=22.12.30.1030

The project is maintained at GitHub: https://github.com/armalagit/FConfig.NetStandard

FConfig

What is FConfig?

FConfig is a simple method to handle application configuration. Supports encryption. It is very easy to use and has no dependencies. Thanks to the framework it uses I don't think there should be any noticable compatibility issues.

Pre-requisites

This little piece of fine code runs on NetStandard 2.0.

How to use

Construct

To construct the initial method call FConfig.Construct(<file path>, <secret key>, <encrypt>) once. Calling this method again reloads the configuration from the file.

FCondig.Construct
Parameter Object type Default value Optional Description
file path string string.Empty false Directory path to where the configuration will be or is saved at.
secret key string string.Empty true A 32 character secret key to use for encryption.
encrypt boolean true true Encrypt configuration before flushing the bytes to disk.
Encrypt

Using encryption requires the secret key to be supplied. The secret key must be a 32 character string.

Get

  • Read value from collection: FConfig.Get<T>(identifier)
Method

Optionally you can supply the method with a fallback object. This fallback object is also written to the configuration file.

Usage Method Return type Object identifier Fallback object (optional)
FConfig.Get<string>("key", "fallback") Get object string object

Set

  • Overwrite new value: FConfig.Set<T>(<identifier>, <value>)
  • Remove value from collection: FConfig.Set<T>(<identifier>)
Method

After each Set<T> the file is written to the disk.

Usage Method Return type Object identifier New value object
FConfig.Set<string>("key", "value") Set object string object
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  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. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
  • .NETStandard 2.0

    • No dependencies.

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
23.1.6.1128 782 1/6/2023
23.1.1.733 771 1/1/2023
23.1.1.715 734 1/1/2023
22.12.30.1030 814 12/30/2022
22.12.19.719 813 12/19/2022