Philiprehberger.JsonMerge
0.1.1
There is a newer version of this package available.
See the version list below for details.
See the version list below for details.
dotnet add package Philiprehberger.JsonMerge --version 0.1.1
NuGet\Install-Package Philiprehberger.JsonMerge -Version 0.1.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="Philiprehberger.JsonMerge" Version="0.1.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Philiprehberger.JsonMerge" Version="0.1.1" />
<PackageReference Include="Philiprehberger.JsonMerge" />
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 Philiprehberger.JsonMerge --version 0.1.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Philiprehberger.JsonMerge, 0.1.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 Philiprehberger.JsonMerge@0.1.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=Philiprehberger.JsonMerge&version=0.1.1
#tool nuget:?package=Philiprehberger.JsonMerge&version=0.1.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
Philiprehberger.JsonMerge
Deep merge JSON documents with configurable array strategies and null handling using System.Text.Json.
Installation
dotnet add package Philiprehberger.JsonMerge
Usage
using System.Text.Json.Nodes;
using Philiprehberger.JsonMerge;
var baseDoc = JsonNode.Parse("""{"name": "app", "db": {"host": "localhost", "port": 5432}}""");
var overrideDoc = JsonNode.Parse("""{"db": {"host": "production.db", "ssl": true}, "version": "2.0"}""");
var result = JsonMerge.Merge(baseDoc!, overrideDoc!);
// {"name": "app", "db": {"host": "production.db", "port": 5432, "ssl": true}, "version": "2.0"}
Custom Options
var options = new MergeOptions(ArrayStrategy.Concat, NullHandling.Remove);
var result = JsonMerge.Merge(baseDoc!, overrideDoc!, options);
Merge Multiple Documents
var result = JsonMerge.MergeAll(defaults, environment, local);
API
JsonMerge
| Method | Description |
|---|---|
Merge(JsonNode baseNode, JsonNode overrideNode) |
Deep merges two JSON documents. Override values win for scalars. |
Merge(JsonNode baseNode, JsonNode overrideNode, MergeOptions options) |
Merges with custom options. |
MergeAll(params JsonNode[] nodes) |
Merges multiple documents left to right. |
MergeOptions
| Property | Description |
|---|---|
ArrayStrategy |
How to handle array merges: Replace (default), Concat, Union. |
NullHandling |
How to handle null values: Keep (default), Remove. |
ArrayStrategy
| Value | Description |
|---|---|
Replace |
Replace base array with override array. |
Concat |
Concatenate both arrays. |
Union |
Union of both arrays. |
NullHandling
| Value | Description |
|---|---|
Keep |
Keep null values in the result. |
Remove |
Remove null values from the result. |
Development
dotnet build src/Philiprehberger.JsonMerge.csproj --configuration Release
License
MIT
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net8.0 is compatible. 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. net9.0 was computed. 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. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net8.0
- No dependencies.
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.