json.get: Difference between revisions
Jump to navigation
Jump to search
Verisimilar (talk | contribs) No edit summary |
Verisimilar (talk | contribs) m (Correcting JSON Array link.) |
||
| Line 4: | Line 4: | ||
|version=1.3b49 | |version=1.3b49 | ||
|description= | |description= | ||
Returns the value in a [[JSON | Returns the value in a [[JSON Array]] at the specified index, returns a slice of a [[JSON Array]] from the specified indexes, or returns the value from [[JSON Object]] for the specified key. | ||
|usage= | |usage= | ||
| Line 17: | Line 17: | ||
</source> | </source> | ||
'''Parameters''' | '''Parameters''' | ||
{{param|array|The JSON | {{param|array|The [[JSON Array]] to retrieve the element from.}} | ||
{{param|index|The numerical index of the element you want returned.}} | {{param|index|The numerical index of the element you want returned.}} | ||
{{param|start|The starting index of the element you wish the slice to begin at.}} | {{param|start|The starting index of the element you wish the slice to begin at.}} | ||
{{param|end|The ending index of the element you wish the slice to end at.}} | {{param|end|The ending index of the element you wish the slice to end at.}} | ||
{{param|object|The JSON | {{param|object|The [[JSON Object]] to retrieve the element from.}} | ||
{{param|key|The name of a field that should be returned. This parameter can exist more than once, if it does then a JSON | {{param|key|The name of a field that should be returned. This parameter can exist more than once, if it does then a [[JSON Object]] is returned with all the specified elements.}} | ||
Negative numbers can be used as the offsets from the end of the array, {{code|-1}} is the last element in the array, {{code|-2}} is the second to last, and so on. If the {{code|end}} index is smaller than the {{code|start}} index then the array slice is returned in reverse. | Negative numbers can be used as the offsets from the end of the array, {{code|-1}} is the last element in the array, {{code|-2}} is the second to last, and so on. If the {{code|end}} index is smaller than the {{code|start}} index then the array slice is returned in reverse. | ||
| Line 37: | Line 37: | ||
|changes= | |changes= | ||
{{change|1.3b51|Added ability to return JSON | {{change|1.3b51|Added ability to return [[JSON Array]] slices.}} | ||
{{change|1.3b51|Added ability to return JSON | {{change|1.3b51|Added ability to return [[JSON Object]]s of select fields from other [[JSON Object]]s.}} | ||
}} | }} | ||
[[Category:JSON Function]] | [[Category:JSON Function]] | ||
Revision as of 00:50, 5 April 2009
This article is a stub, you can help the RPTools Wiki project by contributing content to expand this article.
This article needs: Examples for the new functionality.
json.get() Function
• Introduced in version 1.3b49
Returns the value in a JSON Array at the specified index, returns a slice of a JSON Array from the specified indexes, or returns the value from JSON Object for the specified key.
Usage
json.get(array, index)json.get(array, start, end)json.get(object, key, key, ...)Parameters
array- The JSON Array to retrieve the element from.index- The numerical index of the element you want returned.start- The starting index of the element you wish the slice to begin at.end- The ending index of the element you wish the slice to end at.object- The JSON Object to retrieve the element from.key- The name of a field that should be returned. This parameter can exist more than once, if it does then a JSON Object is returned with all the specified elements.
Negative numbers can be used as the offsets from the end of the array, -1 is the last element in the array, -2 is the second to last, and so on. If the end index is smaller than the start index then the array slice is returned in reverse.
Example
[h:a=json.fromStrProp("a=1;b=44;c=12")] [json.get(a,"b")]
[h:a=json.fromList("1,44,12")] [json.get(a,1)]Returns
4444
Version Changes
- 1.3b51 - Added ability to return JSON Array slices.
- 1.3b51 - Added ability to return JSON Objects of select fields from other JSON Objects.