StrEnum.System.Text.Json
2.0.0
Prefix Reserved
See the version list below for details.
dotnet add package StrEnum.System.Text.Json --version 2.0.0
NuGet\Install-Package StrEnum.System.Text.Json -Version 2.0.0
<PackageReference Include="StrEnum.System.Text.Json" Version="2.0.0" />
paket add StrEnum.System.Text.Json --version 2.0.0
#r "nuget: StrEnum.System.Text.Json, 2.0.0"
// 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 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. |
-
.NETStandard 2.0
- StrEnum (>= 2.0.0 && < 3.0.0)
- System.Text.Json (>= 4.6.0 && < 7.0.0)
NuGet packages (1)
Showing the top 1 NuGet packages that depend on StrEnum.System.Text.Json:
Package | Downloads |
---|---|
StrEnum.AspNetCore
String enum support for ASP.NET Core. |
GitHub repositories
This package is not used by any popular GitHub repositories.