json.path.read: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 3: Line 3:
|version=1.5.5
|version=1.5.5
|description=
|description=
Returns the values in a nested [[JSON Array]] or [[JSON Object]] corresponding to the provided path. It is unnecessary to include the root node operator {{code|$}} at the beginning of the requested path.  To do so, you must ''escape'' the dollar sign like this: {{code|\$.path.to.read}}. For detailed information on how to specify the path, please read the [https://github.com/json-path/JsonPath following document].
Returns the values in a nested [[JSON Array]] or [[JSON Object]] corresponding to the provided path. It is unnecessary to include the root node operator {{code|$}} at the beginning of the requested path.  To do so, you must ''escape'' the dollar sign like this: {{code|\$.path.to.read}}. The {{code|json.path}} functions support both dot, {{code|Monsters.Orc.Attacks}}, and bracket, {{code|['Monsters']['Orc']['Attacks']}}, notation.
 
For detailed information on how to specify the path, please read the [https://github.com/json-path/JsonPath/blob/master/README.md JsonPath ReadMe].


|usage=
|usage=

Revision as of 14:18, 28 September 2019

json.path.read() Function

Introduced in version 1.5.5
Returns the values in a nested JSON Array or JSON Object corresponding to the provided path. It is unnecessary to include the root node operator $ at the beginning of the requested path. To do so, you must escape the dollar sign like this: \$.path.to.read. The json.path functions support both dot, Monsters.Orc.Attacks, and bracket, ['Monsters']['Orc']['Attacks'], notation. For detailed information on how to specify the path, please read the JsonPath ReadMe.

Usage

json.path.read(json, path)

Parameters

  • json - The json element to get the values from.
  • path - The path of the values.

Examples

Suppose we have the following nested json:
[h:troll = json.set("{}", "name", "Troll", "HP", 75, "Attacks", json.append("Claw", "Bite"))]
[h:orc = json.set("{}", "name", "Orc", "HP", 13, "Attacks", json.append("Sword", "Punch"))]
[h:monsters = json.set("{}", "Troll", troll, "Orc", orc)]

To access the value of the first weapon of the Orc, we can type

[json.path.read(monsters, "Orc.Attacks.[0]")]

which returns "Sword".

If we instead wanted to return an array with the attacks of every monster, we could type

[r: json.path.read(monsters, ".Attacks")]

which would return [["Claw","Bite"],["Sword","Punch"]].

Inline filters are also supported, so that if we want the name of the monsters with > 30 HPs, we can type

[r: json.path.read(monsters, ".[?(@.HP > 30)].name")]
which returns ["Troll"].