Newtonsoft.Json

SuperStrong.Types integrates with Newtonsoft.Json. Strong types are serialized as their underlying primitives.

Requirements

This integration targets Newtonsoft.Json 13, so make sure your project uses it.

First, install the package from NuGet:

.NET CLIPackageReference

dotnet add package SuperStrong.Types.NewtonsoftJson --version 1.0.0-beta.5

xml

<PackageReference Include="SuperStrong.Types.NewtonsoftJson" Version="1.0.0-beta.5" />

Strong types aren't annotated for Newtonsoft.Json automatically, so you should either annotate the strong type manually:

csharp

[StrongType<int>]
[JsonConverter(typeof(JsonStrongTypeConverter))] // <-- here
public sealed partial class OrderId;

or register the converter on your settings:

csharp

var settings = new JsonSerializerSettings
{
    Converters = [new JsonStrongTypeConverter()],
};

WARNING

Don't confuse with the System.Text.Json attribute and converter of the same name.

Serialization writes the underlying primitive:

csharp

JsonConvert.SerializeObject(OrderId.From(1), settings); // 1

Deserialization reads it back into the strong type:

csharp

JsonConvert.DeserializeObject<OrderId>("1", settings); // OrderId.From(1)

TIP

When reading from JSON, values go through From(...), so they are always validated.