This documentation outlines what each method does, what it returns or the exceptions it throws, and changes that have been made across versions.
System.Text.Json.Nodes.JsonObject viral32111.JsonExtensions.JsonExtensions.ReadFromFile( string filePath )
Parses the contents of the file at the given path (filePath) as a JSON object.
A JsonObject representing the parsed JSON from the file.
viral32111.JsonExtensions.JsonParseExceptionif the JSON within the file is malformed or otherwise invalid.System.IO.FileNotFoundExceptionif the file at the specified path cannot be found.- In this case, a new JSON file should be created using
viral32111.JsonExtensions.JsonExtensions.CreateNewFile().
- In this case, a new JSON file should be created using
- Introduced in
0.1.0.
System.Text.Json.Nodes.JsonObject viral321111.JsonExtensions.JsonExtensions.CreateNewFile( string filePath, JsonObject? jsonObject = null )
Creates or overwrites the file at the given path (filePath) with the given JSON object (jsonObject), or an empty object if not given.
A JsonObject representing the JSON that was written to the file.
None.
- Fixed the file path not being remembered for use with
JsonObject.SaveToFile()in0.1.1. - Introduced in
0.1.0.
void System.Text.Json.Nodes.JsonObject.SaveToFile( string? filePath = null )
Saves this JSON object to the file at the given path (filePath).
Defaults to the path used when reading or creating the file if no path is given.
Nothing.
None.
- Introduced in
0.1.0.
void System.Text.Json.Nodes.JsonObject.NestedSet( string propertyPath, JsonNode? newValue, char propertyDelimiter = viral32111.JsonExtensions.Defaults.NestedPropertyDelimiter )
Sets the nested property in this JSON object at the given path (propertyPath), separated by the given delimiter (propertyDelimiter), to the given value (newValue).
Nothing.
viral32111.JsonExtensions.JsonPropertyNullExceptionif one of the property names expected to be aJsonObjectis null.
System.Text.Json.Nodes.JsonNode? System.Text.Json.Nodes.JsonObject.NestedGet( string propertyPath, char propertyDelimiter = viral32111.JsonExtensions.Defaults.NestedPropertyDelimiter )
Gets the nested property in this JSON object at the given path (propertyPath), separated by the given delimiter (propertyDelimiter).
A JsonNode? representing the value of the property. May be null.
viral32111.JsonExtensions.JsonPropertyNullExceptionif one of the nested parent JSON object properties is null.viral32111.JsonExtensions.JsonPropertyNotFoundExceptionif one of the nested JSON object properties does not exist.
- Added
propertyDelimiterparameter in0.3.0. - Throw
viral32111.JsonExtensions.JsonPropertyNotFoundExceptioninstead ofSystem.Text.Json.JsonExceptionwhen a nested property does not exist in0.1.2. - Introduced in
0.1.0.
System.Type System.Text.Json.Nodes.JsonObject.NestedGet<T>( string propertyPath, char propertyDelimiter = viral32111.JsonExtensions.Defaults.NestedPropertyDelimiter )
Gets the nested property in this JSON object at the given path (propertyPath), separated by the given delimiter (propertyDelimiter), as the given data type (T).
Best sticking to primitive data types, JsonObject and JsonArray.
The value of the property as the given data type (T).
viral32111.JsonExtensions.JsonPropertyNullExceptionif the value of the property cannot be casted because it is null.
See viral32111.JsonExtensions.JsonObject.NestedGet() for more exceptions that may be thrown.
bool System.Text.Json.Nodes.JsonObject.NestedHas( string propertyPath, char propertyDelimiter = viral32111.JsonExtensions.Defaults.NestedPropertyDelimiter )
Checks if a nested property exists in this JSON object at the given path (propertyPath), separated by the given delimiter (propertyDelimiter).
A null property value counts as the property existing.
True or False representing if the property exists.
viral32111.JsonExtensions.JsonPropertyNullExceptionif one of the property names expected to be aJsonObjectis null.
string[] System.Text.Json.Nodes.JsonObject.NestedList( char propertyDelimiter = viral32111.JsonExtensions.Defaults.NestedPropertyDelimiter )
Creates a list of paths to all nested properties in this JSON object, with nested objects separated by the given delimiter (propertyDelimiter).
Null property values are included.
A list of paths to all nested JSON object properties.
None.
System.Type[] System.Text.Json.Nodes.JsonNode.AsArray<T>()
Converts this JSON node, which must be a JSON array, to a fixed-length typed array of the given data type (T).
A typed array of the given data type (T) containing the elements within this JSON array.
viral32111.JsonExtensions.JsonPropertyNullExceptionif a value in the JSON array is null.
- Introduced in
0.1.0.
System.Text.Json.Nodes.JsonNode? System.Text.Json.Nodes.JsonNode?.Clone()
Creates a copy of this JSON node.
A copy of this JSON node, or null if this JSON node is null.
None.
- Introduced in
0.2.0.