dotnet

ObjectBasin

.NET library to stream updates to an object using JSONPaths and JSON Patch Pointers. It is called Basin because streams flow into a basin.

See in NuGet.

This library supports various ways to update objects or their contents:

• appending to the end of a string
• inserting anywhere in a string
• removing characters from a string
• appending to the end of a list
• inserting anywhere in a list
• overwriting an item in a list
• deleting items in a list
• setting a value in an object
• tracking different cursors for different streams

Learn more at https://github.com/microsoft/object-basin.

Unsupported Operations

Unlike the JavaScript/TyperScript version of this library which relies on simpler objects, this .NET version does not yet support operations such as adding or modifying all types of items within JsonElements or other complex structures. String manipulation is supported within JsonElements such as appending to a string, but other operations such as adding to a list or some types of replacement are not supported yet.

To be clear, deep manipulation within .NET objects (POCOs) is fine. The limitation is with some complex objects that require their own complex parsers.

Install

dotnet add package ObjectBasin

Examples

See examples in the tests.

Development

Code Formatting

CI enforces:

dotnet format --verify-no-changes --severity info --no-restore *.sln

To automatically format code, run:

dotnet format --severity info --no-restore *.sln

Publishing

From the dotnet folder in the root of the repo, run:

$api_key=<your NuGet API key>
dotnet pack --configuration Release
dotnet nuget push src/bin/Release/ObjectBasin.*.nupkg --source https://api.nuget.org/v3/index.json -k $api_key --skip-duplicate