JNode

Dim myJNode As JNode

A node of a JSON document: an object, an array, or a value.

None

JNode is the common type of every node. The concrete node is a `JElement` (JSON object), a `JArray` or a `JValue`; NodeType tells which. Declare variables As JNode when the kind does not matter, and as the concrete class to reach its own members.

The default member Item makes paths short: root("customer")("name") and root("orders")(0). Positions are 0-based everywhere, as in JPath and in MSXML node lists; object keys are case-sensitive, as in JSON itself.

Not created directly; returned by other members of the library.

Dim order As JNode
For Each order In doc.SelectNodes("$.orders[*]")
    Debug.Print order.GetLong("id"), order("total").Value
Next

None

Property Get Item(ByVal Index As Variant) As JNode

Returns a child node by key (object) or by 0-based position (array).

Property value: `JNode` – The child node.

A missing key raises jeNotFound, a position outside the node raises jeIndexOutOfRange; use `Exists` or SelectSingleNode to test first. An object also takes a 0-based position (its keys in document order); an array takes positions only, a key raises jeTypeMismatch. Negative positions are refused here (JPath takes them: $.lines[-1]). Calling Item on a value node raises jeInvalidOperation. A String index is always a key, also "0"; convert it with CLng for an array. Other index types are converted to Long with the rules of VBA (1.5 becomes 2).

Default member: it can be left out, as in myJNode(...) for myJNode.Item(...). Read-only.

None

Declared by JNode; also available on `JElement`, `JArray`, `JValue`.

Property Get Value() As Variant
Property Let Value(RHS As Variant)

Gets or sets the value of a value node as a Variant.

None

Property value: Variant – The value in its natural VBA type.

Reading returns Long for whole numbers within the Long range, Decimal for larger whole numbers (exact up to 28 digits, enough for 19-digit identifiers), Double for numbers with a fraction or exponent and for whole numbers beyond the Decimal range, String, Boolean, or Null; a number beyond the Double range raises jeTypeMismatch. The stored text never changes (Json, Save, GetString); a Double result carries only 15-17 significant digits. Use GetCurrency or GetDecimal for amounts (see Values and limits).

Writing accepts String, the numeric types, Boolean, Date (written as ISO 8601), Null, and Empty (written as null). Reading Value of an object or array raises jeInvalidOperation; use ToJson for their text.

Read/write.

None

Declared by JNode; also available on `JElement`, `JArray`, `JValue`.

Property Get NodeType() As JNodeType

Returns the kind of the node.

None

Property value: `JNodeType` – One of the `JNodeType` constants.

Read-only.

None

Declared by JNode; also available on `JElement`, `JArray`, `JValue`.

Property Get Name() As String

Returns the key of the node in its parent object.

None

Property value: String – The key; an empty string for array elements and for the root node.

Read-only.

None

Declared by JNode; also available on `JElement`, `JArray`, `JValue`.

Property Get Index() As Long

Returns the 0-based position of the node in its parent object or array.

None

Property value: Long – The position; -1 for the root node.

Read-only.

None

Declared by JNode; also available on `JElement`, `JArray`, `JValue`.

Property Get Parent() As JNode

Returns the parent node.

None

Property value: `JNode` – The parent; Nothing for the root node and for a node that is not attached to a document tree.

Read-only.

None

Declared by JNode; also available on `JElement`, `JArray`, `JValue`.

Property Get Document() As JDoc

Returns the document the node belongs to.

None

Property value: `JDoc` – The `JDoc` that created the node.

Read-only.

None

Declared by JNode; also available on `JElement`, `JArray`, `JValue`.

Property Get Path() As String

Returns the JPath of the node.

None

Property value: String – This library's canonical path from the root in dot notation, for example $.orders[0].id; it finds the node again with SelectSingleNode. It is not the bracket form of a Normalized Path of RFC 9535 (section 2.7).

The path can be passed to SelectSingleNode of the same document to find the node again, as long as the tree has not changed.

Read-only.

None

Declared by JNode; also available on `JElement`, `JArray`, `JValue`.

Property Get Count() As Long

Returns the number of child nodes.

None

Property value: Long – The number of keys (object) or elements (array); 0 for a value node.

Read-only.

None

Declared by JNode; also available on `JElement`, `JArray`, `JValue`.

Property Get HasChildren() As Boolean

Tells whether the node has child nodes.

None

Property value: Boolean – True when Count is greater than 0.

Read-only.

None

Declared by JNode; also available on `JElement`, `JArray`, `JValue`.

Property Get ChildNodes() As JNodeList

Returns all child nodes as a list.

None

Property value: `JNodeList` – A `JNodeList` of the keys' nodes (object, in document order) or the elements (array).

Read-only.

None

Declared by JNode; also available on `JElement`, `JArray`, `JValue`.

Property Get IsNull() As Boolean

Tells whether the node holds the JSON value null.

None

Property value: Boolean – True for a null value node.

Read-only.

None

Declared by JNode; also available on `JElement`, `JArray`, `JValue`.

Property Get StringValue() As String

Returns the value as text; for an object or array, its JSON text.

None

Property value: String – Strings unchanged, numbers as written in the document, true/false, an empty string for null, or compact JSON for objects and arrays.

Read-only.

None

Declared by JNode; also available on `JElement`, `JArray`, `JValue`.

Function ToJson(Optional ByVal Indent As Boolean = False) As String

Returns the node as JSON text.

Return value: String – The JSON text of the node and its children.

None

None

Declared by JNode; also available on `JElement`, `JArray`, `JValue`.

Function JPath(ByVal Path As String) As JNode

Returns the first node a JPath expression finds, or Nothing: a short form of SelectSingleNode.

Return value: `JNode` – The first node found, or Nothing.

None

None

Declared by JNode; also available on `JElement`, `JArray`, `JValue`.

Function SelectSingleNode(ByVal Path As String) As JNode

Returns the first node a JPath expression finds, or Nothing.

Return value: `JNode` – The first node found in document order, or Nothing.

JPath follows RFC 9535 (JSONPath): $, @, .name, ['name'], [n] with negative positions counting from the end, [*], .. (recursive descent), unions [a,b], slices [start:end:step], and filters [?...] with ==, !=, <, <=, >, >=, &&, ||, ! and the functions length, count, match, search, value. The Goessner form [?(@.price < 10)] works too. Extensions: a path without $ or @ starts at the current node (customer.name), - is allowed in short names ($.headers.content-type). All extensions and deviations from RFC 9535 are listed in Values and limits: JPath. An invalid expression raises jePathSyntax. Compiled expressions are cached, so evaluating the same path in a loop costs the parse once.

Dim cheap As JNode
Set cheap = doc.SelectSingleNode("$.items[?@.price < 10 && @.kind == 'A']")
If Not cheap Is Nothing Then Debug.Print cheap("name").Value

Declared by JNode; also available on `JElement`, `JArray`, `JValue`.

Function SelectNodes(ByVal Path As String) As JNodeList

Returns all nodes a JPath expression finds.

Return value: `JNodeList` – A `JNodeList` in document order; empty when nothing is found.

None

None

Declared by JNode; also available on `JElement`, `JArray`, `JValue`.

Function Exists(ByVal Path As String) As Boolean

Tells whether a JPath expression finds at least one node.

Return value: Boolean – True when at least one node is found.

None

None

Declared by JNode; also available on `JElement`, `JArray`, `JValue`.

Function GetString(ByVal Path As String, Optional ByVal Default As Variant) As String

Returns the value at a JPath as String, or a default.

Return value: String – The value as String.

All getters (GetString, GetLong, GetDouble, GetCurrency, GetDecimal, GetDate, GetBoolean, GetValue) follow the same rules, like Access' Nz():

• Without Default, a path that finds nothing raises jeNotFound, and a JSON null raises jeTypeMismatch.
• With Default, both return the default instead.
• A value of the wrong type always raises jeTypeMismatch, with or without default: a silently substituted value would hide a data problem.

Numbers written as strings are read when their text without surrounding spaces is a JSON number: "42" and " 4.2 " are read; "007", "+5", ".5" and "12,5" raise jeTypeMismatch. What each getter accepts, rounds and refuses: Values and limits.

Debug.Print doc.GetString("$.customer.name")
Debug.Print doc.GetString("$.customer.fax", "none")   ' like Nz()

Declared by JNode; also available on `JElement`, `JArray`, `JValue`.

Function GetLong(ByVal Path As String, Optional ByVal Default As Variant) As Long

Returns the value at a JPath as Long, or a default.

Return value: Long – The value as Long.

A number with a fraction, or a number outside -2,147,483,648 to 2,147,483,647, raises jeTypeMismatch instead of being truncated; 12.0 and 1e3 are whole numbers and are accepted. The general rules are described under `GetString`.

None

Declared by JNode; also available on `JElement`, `JArray`, `JValue`.

Function GetDouble(ByVal Path As String, Optional ByVal Default As Variant) As Double

Returns the value at a JPath as Double, or a default.

Return value: Double – The value as Double.

Converted from the written text to the nearest Double (15-17 significant digits): 9007199254740993 reads as 9007199254740992, magnitudes below about 5E-324 read as 0. A number beyond the Double range (1e400) raises jeTypeMismatch.

None

Declared by JNode; also available on `JElement`, `JArray`, `JValue`.

Function GetCurrency(ByVal Path As String, Optional ByVal Default As Variant) As Currency

Returns the value at a JPath as Currency (converted from the written text, rounded to four decimal places), or a default.

Return value: Currency – The value as Currency, converted from the written text without a detour through Double.

More than four decimal places are rounded to four with banker's rounding, as CCur does; a magnitude below 1E-28 becomes 0. A number outside the Currency range raises jeTypeMismatch.

None

Declared by JNode; also available on `JElement`, `JArray`, `JValue`.

Function GetDecimal(ByVal Path As String, Optional ByVal Default As Variant) As Variant

Returns the value at a JPath as a Decimal Variant (converted from the written text, 28-29 significant digits), or a default.

Return value: Variant – The value as Variant of subtype Decimal (up to 28 significant digits).

None

None

Declared by JNode; also available on `JElement`, `JArray`, `JValue`.

Function GetDate(ByVal Path As String, Optional ByVal Default As Variant) As Date

Returns the value at a JPath as Date, or a default.

Return value: Date – The date read from an ISO 8601 string.

JSON has no date type; dates are ISO 8601 strings such as 2026-09-25, 2026-09-25T14:30:00Z or 2026-09-25T14:30:00+02:00. A time with a zone is converted as the document's `DateZone` says. A non-string value (for example a Unix timestamp), a string that is not ISO 8601, or a date before 1 January 100 raises jeTypeMismatch. Leading and trailing spaces are ignored; T, t or a space separate date and time; Z or z mean UTC.

None

Declared by JNode; also available on `JElement`, `JArray`, `JValue`.

Function GetBoolean(ByVal Path As String, Optional ByVal Default As Variant) As Boolean

Returns the value at a JPath as Boolean, or a default.

Return value: Boolean – The value as Boolean.

Accepted are JSON true and false, the strings "true" and "false" in any case, and numbers: a number that is 0 after the conversion to Decimal is False - this includes numbers below 1E-28 such as 1e-30, unlike CBool - and every other number, also one beyond the Decimal range, is True. Other strings raise jeTypeMismatch.

None

Declared by JNode; also available on `JElement`, `JArray`, `JValue`.

Function GetValue(ByVal Path As String, Optional ByVal Default As Variant) As Variant

Returns the value at a JPath as Variant, or a default.

Return value: Variant – The value in its natural VBA type, as `Value` returns it.

None

None

Declared by JNode; also available on `JElement`, `JArray`, `JValue`.

Function Clone() As JNode

Returns an independent copy of the node and its children.

None

Return value: `JNode` – A copy that belongs to the same document but is not attached to any parent.

The copy can be inserted elsewhere with SetValue, Add or Insert; changes to it do not affect the original.

None

Declared by JNode; also available on `JElement`, `JArray`, `JValue`.

Sub Remove()

Removes the node from its parent object or array.

None

The node stays usable through the VBA variable as a detached node and can be inserted again. Removing the root node empties the document: Root becomes Nothing. A node without parent that is not the root of its document stays as it is.

None

Declared by JNode; also available on `JElement`, `JArray`, `JValue`.