ObjectBasin 1.2.1

.NET Standard 2.1 This package targets .NET Standard 2.1. The package is compatible with this framework or higher.
The owner has unlisted this package. This could mean that the package is deprecated, has security vulnerabilities or shouldn't be used anymore. 
dotnet add package ObjectBasin --version 1.2.1
                    


                    

                
NuGet\Install-Package ObjectBasin -Version 1.2.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="ObjectBasin" Version="1.2.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="ObjectBasin" Version="1.2.1" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="ObjectBasin" />
                    


                            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 ObjectBasin --version 1.2.1
                    


                    

                
#r "nuget: ObjectBasin, 1.2.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 ObjectBasin@1.2.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=ObjectBasin&version=1.2.1
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=ObjectBasin&version=1.2.1
                    


                            Install as a Cake Tool

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
Product 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.  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. 
.NET Core netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.1 is compatible. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated