Skip to content

JavaScript/TypeScript + .NET libraries to stream updates to an object using JSONPaths and JSON Patches

License

Notifications You must be signed in to change notification settings

microsoft/object-basin

Repository files navigation

Basin

A specification and libraries to stream updates to an object using JSONPaths. We use the term "basin" because streams flow into a basin.

See in npmjs.com.

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

JavaScript / Node.js

See examples and installation instructions in the js folder.

.NET / C#

See examples and installation instructions in the dotnet folder.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.