Iciclecreek.ObjectPath
1.1.0
dotnet add package Iciclecreek.ObjectPath --version 1.1.0
NuGet\Install-Package Iciclecreek.ObjectPath -Version 1.1.0
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="Iciclecreek.ObjectPath" Version="1.1.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Iciclecreek.ObjectPath" Version="1.1.0" />
<PackageReference Include="Iciclecreek.ObjectPath" />
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 Iciclecreek.ObjectPath --version 1.1.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Iciclecreek.ObjectPath, 1.1.0"
#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.
#addin nuget:?package=Iciclecreek.ObjectPath&version=1.1.0
#tool nuget:?package=Iciclecreek.ObjectPath&version=1.1.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
ObjectPath
ObjectPath is a utility class which allows you to retreive/set object path properties on dynamic and typed objects.
Paths
Let's say you have an object, it could be a typed object, or dynamic object or even a dictionary.
ObjectPath allows you to dynamically navigate the object hierachy using a string path expression.
For example:
if (ObjectPath.TryGetValue<int>("x.y.z", out var val))
{
// use val is a int
}
Methods
| Methods | Description |
|---|---|
| HasValue(obj, path) | returns true if the path can be evaluated against obj |
| GetPathValue<T>(obj, path) | returns the result of evaluating path as T if it exists, or throws if the path doesn't |
| TryGetValueValue<T>(obj, path, out T) | retruns the result of valuating the path if it exists |
| SetPathValue(obj, path, val) | sets the path to a given value |
| RemovePathValue(obj, path) | removes the leaf of path (for dynamic objects) or resets it to default for typed objects |
| GetProperties(obj) | enumerates public properties for objects/dictionaries/dynamic objects |
| ForEachProperty(obj, action) | calls action with each public properties for objects/dictionaries/dynamic objects |
| ContainsProperty(obj, prop) | shallow inspection to see if current object has a property/value named prop |
| Clone<T>(obj) | creates a deep clone of public properties and all of it's children |
| Merge<T>(startObj, overlayObj) | creates a new object which is clone of startObj with any properties defined on overlayObj merged over it |
| Assign<T>(startObj, overlayObj) | creates a new object which is clone of startObj with any properties defined on overlayObj merged over it |
| MapValueTo<T>(obj) | coercices an object to a given type. |
Examples
var dyn = new { X = 13, Y = new {Z = "15" } };
ObjectPath.GetPathValue(dyn, "X"); ==> 13
ObjectPath.GetPathValue(dyn, "X.Y.Z"); ==> "15"
ObjectPath.GetPathValue<int>(dyn, "X.Y.Z"); ==> 15
ObjectPath.HasPathValue(dyn, "X.Y") ==> true
ObjectPath.HasPathValue(dyn, "X.FOO") ==> false
// you can set path values without having to check sub parts, it will use JTokens to build the path.
ObjectPath.SetPathValue(dyn, "X.FOO.Zoo", "hello");
ObjectPath.HasPathValue(dyn, "X.FOO") ==> true
ObjectPath.GetPathValue(dyn, "X.FOO.Zoo") ==> "hello"
etc
| Product | Versions 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 | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
| .NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
| .NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
| MonoAndroid | monoandroid was computed. |
| MonoMac | monomac was computed. |
| MonoTouch | monotouch was computed. |
| Tizen | tizen40 was computed. 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.
-
.NETStandard 2.0
- Microsoft.CSharp (>= 4.7.0)
- Newtonsoft.Json (>= 13.0.3)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.