StrEnum.System.Text.Json 2.0.0

The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org. Prefix Reserved
.NET Standard 2.0
dotnet add package StrEnum.System.Text.Json --version 2.0.0
NuGet\Install-Package StrEnum.System.Text.Json -Version 2.0.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="StrEnum.System.Text.Json" Version="2.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add StrEnum.System.Text.Json --version 2.0.0
#r "nuget: StrEnum.System.Text.Json, 2.0.0"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install StrEnum.System.Text.Json as a Cake Addin
#addin nuget:?package=StrEnum.System.Text.Json&version=2.0.0

// Install StrEnum.System.Text.Json as a Cake Tool
#tool nuget:?package=StrEnum.System.Text.Json&version=2.0.0

StrEnum.System.Text.Json

Allows for StrEnum string enum JSON serialization and deserialization with System.Text.Json.

The package targets .NET Standard 2.0 and can be used with System.Text.Json 4.6.0-6.*.

Installation

You can install StrEnum.System.Text.Json using the .NET CLI:

dotnet add package StrEnum.System.Text.Json

Usage

Create a string enum and a class that contains it:

public class Sport : StringEnum<Sport>
{
    public static readonly Sport RoadCycling = Define("ROAD_CYCLING");
}

public class Race
{
    public string Name { get; set; }
    public Sport Sport { get; set; }
}

Configure JsonSerializerOptions by calling the UseStringEnums() method and pass it to JsonSerializer :

var options = new JsonSerializerOptions().UseStringEnums();

Serialize to JSON:

var ctct = new Race { Name = "Cape Town Cycle Tour", Sport = Sport.RoadCycling };

var json = JsonSerializer.Serialize(ctct, options);

The above produces:

{"Name":"Cape Town Cycle Tour","Sport":"ROAD_CYCLING"}

Deserialize from JSON:

{"Name":"Cape Town Cycle Tour","Sport":"ROAD_CYCLING"}

The above JSON can be deserialized into a C# object that contains a StrEnum enum:

var race = JsonSerializer.Deserialize<Race>(json, options);

// race is equivalent to:
new { Name = "Cape Town Cycle Tour", Sport = Sport.RoadCycling };

License

Copyright © 2022 Dmitry Khmara.

StrEnum is licensed under the MIT license.

Product Versions
.NET net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows net7.0 net7.0-android net7.0-ios net7.0-maccatalyst net7.0-macos net7.0-tvos net7.0-windows
.NET Core netcoreapp2.0 netcoreapp2.1 netcoreapp2.2 netcoreapp3.0 netcoreapp3.1
.NET Standard netstandard2.0 netstandard2.1
.NET Framework net461 net462 net463 net47 net471 net472 net48
MonoAndroid monoandroid
MonoMac monomac
MonoTouch monotouch
Tizen tizen40 tizen60
Xamarin.iOS xamarinios
Xamarin.Mac xamarinmac
Xamarin.TVOS xamarintvos
Xamarin.WatchOS xamarinwatchos
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on StrEnum.System.Text.Json:

Package Downloads
StrEnum.AspNetCore The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

String enum support for ASP.NET Core.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2.0.0 223 7/29/2022
1.1.0 261 5/18/2022
1.0.0 155 5/18/2022