Armala.FConfig 23.1.1.715

There is a newer version of this package available.
See the version list below for details.

dotnet add package Armala.FConfig --version 23.1.1.715

NuGet\Install-Package Armala.FConfig -Version 23.1.1.715

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="23.1.1.715" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

paket add Armala.FConfig --version 23.1.1.715

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: Armala.FConfig, 23.1.1.715"

#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=23.1.1.715

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

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

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. In an essence this is just a fancy Dictionary<key, value> which saves the collection array to a disk and even encrypts it. Because this is actually a Dictionary in disguise you can save anything as the value. 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 this method once per project initialization. Calling this method again in the same instance reloads the configuration from the file.

FConfig.Construct

Parameter	Object type	Default value	Optional	Description
configurationPath	string	string.Empty	false	Directory path to where the configuration will be or is saved at.
secretKey	string	string.Empty	true	A 32 character secret key to use for encryption.
useEncryption	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

Reads the specified configuration item from the collection.

FConfig.Get

Parameter	Object type	Default value	Optional	Description
identifier	string	string.Empty	false	Configuration collection item identifier.
fallback	object	defaukt	true	Configuration fallback item to return on null result.

Set

Sets the specified value in the configuration collection.

FConfig.Set

After each Set<T> the configuration bytes are flushed to the disk. | Parameter| Object type | Default value | Optional | Description | |---|---|---|---|---| | identifier | string | string.Empty | false | Configuration collection item identifier. | | newValue | object | defaukt | false | New value. |

Del

Removes the specified configuration item from the collection.

FConfig.Del

After each Del<T> the configuration bytes are flushed to the disk. | Parameter| Object type | Default value | Optional | Description | |---|---|---|---|---| | identifier | string | string.Empty | false | Configuration collection item identifier. |

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