json.remove: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
No edit summary
 
(5 intermediate revisions by 4 users not shown)
Line 3: Line 3:
|version=1.3b49
|version=1.3b49
|description=
|description=
Removes a field from a [[Macros:json object|json object]], or the value at the specified index from a [[Macros:json array|json array]].
Removes a field from a [[JSON Object]], or the value at the specified index from a [[JSON Array]]. If the field is not present in the [[JSON Object]], it is returned unchanged. If the index does not exist in a [[JSON Array]], a java.lang.IndexOutOfBoundsException is raised.


|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[h: jarr = json.remove(jarr, index)]
[h: jarr = json.remove(jarr, index)]
[h: jarr = json.remove(jobj, key)]
[h: jarr = json.remove(jobj, key)]
</source>
</syntaxhighlight>


|examples=
|examples=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
   [h:a=json.fromStrProp("a=1;b=44;c=12")] [r:json.remove(a, "c")]
   [h:a=json.fromStrProp("a=1;b=44;c=12")] [r:json.remove(a, "c")]
   [h:a=json.fromList("a,1,g,4")][r:json.remove(a,3)]
   [h:a=json.fromList("a,1,g,4")][r:json.remove(a,3)]
</source>
</syntaxhighlight>


Returns
Returns

Latest revision as of 23:59, 15 March 2023

json.remove() Function

Introduced in version 1.3b49
Removes a field from a JSON Object, or the value at the specified index from a JSON Array. If the field is not present in the JSON Object, it is returned unchanged. If the index does not exist in a JSON Array, a java.lang.IndexOutOfBoundsException is raised.

Usage

[h: jarr = json.remove(jarr, index)]
[h: jarr = json.remove(jobj, key)]

Examples

  [h:a=json.fromStrProp("a=1;b=44;c=12")] [r:json.remove(a, "c")]
  [h:a=json.fromList("a,1,g,4")][r:json.remove(a,3)]

Returns

 {"a":1,"b":44}
["a",1,"g"]