Javascript JSON
(→Methods) |
|||
Line 52: | Line 52: | ||
'''sqlEscape''': Optional. True to apply SQL escaping to parameter values<br> | '''sqlEscape''': Optional. True to apply SQL escaping to parameter values<br> | ||
'''extraEsc''': Character to escape other than the SQL default ones<br> | '''extraEsc''': Character to escape other than the SQL default ones<br> | ||
+ | |||
+ | |||
+ | * '''findPath(obj, path)''' | ||
+ | Find object property value or array at index value by a JSON path.<br> | ||
+ | Parameters:<br> | ||
+ | '''obj''': Object to search in<br> | ||
+ | '''path''': Path to use. May be a JPath object or a string<br> | ||
+ | Return:<br> | ||
+ | Found value, '''undefined''' if not found, '''obj''' is not an object or path is invalid | ||
+ | |||
+ | * '''replaceReferences(obj)''' | ||
+ | Replace path references in given object properties or array values.<br> | ||
+ | A path reference is an object with a '''$ref''' property with value containing a path URI as specified in RFC 6901.<br> | ||
+ | Parameters:<br> | ||
+ | '''obj''': Object to search in<br> | ||
+ | Return:<br> | ||
+ | True on success, false otherwise |
Revision as of 13:12, 27 October 2021
JSON parsing global object.
Methods
- parse(str)
Parse JSON string.
Parameters:
str String containing JSON data
Return:
Primitive type or object representing the data, undefined if parsing failed.
- stringify(obj,unused,spaces)
Stringify a Javascript primitive or object.
Parameters:
obj Object of primitive type
unused Unused optional parameter, for compatibility with the standard
spaces Optional number of spaces to use for indentation
Return:
String JSON data, undefined is an error occured.
- loadFile(name)
Parse JSON file (non-standard method).
Parameters:
name Name of the file containing JSON data
Return:
Primitive type or object representing the data, undefined if parsing failed.
- saveFile(name,obj,spaces)
Save JSON data in a file (non-standard method).
Parameters:
name Name of the JSON file to write
unused Unused optional parameter, for compatibility with the standard
spaces Optional number of spaces to use for indentation
Return:
TRUE if operation succeeded, FALSE if an error occured.
- replaceParams(obj, params [,sqlEscape [,extraEsc]])
Replace ${paramname} instances in 'buf' from 'params' field values.
Replacements are done in string property values.
Parameters:
buf: Array: replace in its elements. Object: replace in its properties. Any other type is ignored
params: Object whose fields are used to replace. Ignored (no replace is made) if not an object
sqlEscape: Optional. True to apply SQL escaping to parameter values
extraEsc: Character to escape other than the SQL default ones
- findPath(obj, path)
Find object property value or array at index value by a JSON path.
Parameters:
obj: Object to search in
path: Path to use. May be a JPath object or a string
Return:
Found value, undefined if not found, obj is not an object or path is invalid
- replaceReferences(obj)
Replace path references in given object properties or array values.
A path reference is an object with a $ref property with value containing a path URI as specified in RFC 6901.
Parameters:
obj: Object to search in
Return:
True on success, false otherwise