StrongTypedId.NewtonSoft 2.3.1

.NET 9.0

dotnet add package StrongTypedId.NewtonSoft --version 2.3.1

NuGet\Install-Package StrongTypedId.NewtonSoft -Version 2.3.1

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="StrongTypedId.NewtonSoft" Version="2.3.1" />

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

<PackageVersion Include="StrongTypedId.NewtonSoft" Version="2.3.1" />
                    

                            Directory.Packages.props

<PackageReference Include="StrongTypedId.NewtonSoft" />
                    

                            Project file

For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.

paket add StrongTypedId.NewtonSoft --version 2.3.1

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

#r "nuget: StrongTypedId.NewtonSoft, 2.3.1"

#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.

#:package StrongTypedId.NewtonSoft@2.3.1

#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.

#addin nuget:?package=StrongTypedId.NewtonSoft&version=2.3.1
                    

                            Install as a Cake Addin

#tool nuget:?package=StrongTypedId.NewtonSoft&version=2.3.1
                    

                            Install as a Cake Tool

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

StrongTypedId.NewtonSoft

This package provides support for using StrongTypedId with the NewtonSoft JSON serializer.

Usage

First add the StrongTypedNewtonSoftJsonConverter to your serializer settings.

var settings = new JsonSerializerSettings
{
    Converters = { new StrongTypedNewtonSoftJsonConverter() }
};

var json = JsonConvert.SerializeObject(UserId.New(), settings);

var serializer = new JsonSerializer()
{
    Converters = { new StrongTypedNewtonSoftJsonConverter() }
};

var json = serializer.Serialize(writer, UserId.New());

This will serialize any StrongTypedId, StrongTypedGuid or StrongTypedValue with explicit type information, allowing deserialization even if your model is abstract.

If you furthermore have types you'd prefer serialized as their underlying value, you can add a Newtonsoft.Json.JsonConverter attribute to the type:

[StrongTypedValueJsonConverterFactory]

[Newtonsoft.Json.JsonConverter(typeof(NewtonSoftJsonConverter<UserId, Guid>))] // This is the converter for NewtonSoft.

public class UserId: StrongTypedId<UserId, Guid>
{
	public UserId(Guid value) : base(value)
	{
	}
}

Notice how you can have both JsonConverters applied simultaneously to support both WebAPI and NewtonSoft at the same time.

Documentation

Auto generated documentation via DocFx is available here: https://steffenskov.github.io/StrongTypedId/

Product	Compatible and additional computed target framework versions.
.NET	net9.0 is compatible. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed.

Product

.NET

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

net9.0
- Newtonsoft.Json (>= 13.0.3)
- StrongTypedId (>= 2.3.1)

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.