Codibre.CaseInsensitiveEnum 0.1.0

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

// Install Codibre.CaseInsensitiveEnum as a Cake Tool
#tool nuget:?package=Codibre.CaseInsensitiveEnum&version=0.1.0                

Actions Status Actions Status Actions Status benchmark Test Coverage Maintainability

JsonConvert to treat any Enum as case insensitive

Why

Case insensitive enum conversion can lead to more compatibility throughOut a cross-platform as, for best practice, we never use two enum values equivalents case insensitive, and depending on language best practices, some service implemented in a different language may implement the enum differently, so, a case insensitive conversion can save you a lot of discussion time.

How to use it

First, import the application namespace:

using Codibre.CaseInsensitiveEnum

Now, create a singleton option to use in very needed conversion. It is important to create it singleton to avoid performances issues (not related to this package, though):

readonly static JsonSerializerOptions options = new JsonSerializerOptions
{
    Converters = { new CaseInsensitiveEnumConverter() },
    PropertyNameCaseInsensitive = true,
    PropertyNamingPolicy = JsonNamingPolicy.CamelCase,
};

Finally, use the created option on your Serializer:

var converted = JsonSerializer.Deserialize<MyTargetClass>(serializedValue, options);

That's it! For best practice, is good to create a serializer class, or method extension, centralized to use through your project, guaranteeing, that way, a singleton option definition.

Also, notice that, if we're talking about case insensitive serialization for enum, it is implied that you're serializing it to the enum property name, not the value, so, be aware that using this package for your serialization will lead to that behavior.

License

Licensed under MIT.

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.

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
0.1.1 244 12/17/2023
0.1.0 125 12/17/2023