diff options
| author | skyace65 <trekie96@hotmail.com> | 2022-01-18 21:51:29 -0500 |
|---|---|---|
| committer | skyace65 <trekie96@hotmail.com> | 2022-01-19 08:32:58 -0500 |
| commit | 03257fcecb6265680a590498380e8b1da36ec0bb (patch) | |
| tree | e32ccd2e58343b64be08f830a5d454d4e41ed21d | |
| parent | f8b8d0d4b82a5eb6ea3829398fd5076f1c49c148 (diff) | |
Better explain JSON stringify indent parameter (4.0)
| -rw-r--r-- | doc/classes/JSON.xml | 42 |
1 files changed, 29 insertions, 13 deletions
diff --git a/doc/classes/JSON.xml b/doc/classes/JSON.xml index 63e6307b39..fed9df8bd8 100644 --- a/doc/classes/JSON.xml +++ b/doc/classes/JSON.xml @@ -66,7 +66,7 @@ Converts a [Variant] var to JSON text and returns the result. Useful for serializing data to store or send over the network. [b]Note:[/b] The JSON specification does not define integer or float types, but only a [i]number[/i] type. Therefore, converting a Variant to JSON text will convert all numerical values to [float] types. [b]Note:[/b] If [code]full_precision[/code] is true, when stringifying floats, the unreliable digits are stringified in addition to the reliable digits to guarantee exact decoding. - Use [code]indent[/code] parameter to pretty stringify the output. + The [code]indent[/code] parameter controls if and how something is indented, the string used for this parameter will be used where there should be an indent in the output, even spaces like [code]" "[/code] will work. [code]\t[/code] and [code]\n[/code] can also be used for a tab indent, or to make a newline for each indent respectively. [b]Example output:[/b] [codeblock] ## JSON.stringify(my_dictionary) @@ -74,18 +74,34 @@ ## JSON.stringify(my_dictionary, "\t") { - "name": "my_dictionary", - "version": "1.0.0", - "entities": [ - { - "name": "entity_0", - "value": "value_0" - }, - { - "name": "entity_1", - "value": "value_1" - } - ] + "name": "my_dictionary", + "version": "1.0.0", + "entities": [ + { + "name": "entity_0", + "value": "value_0" + }, + { + "name": "entity_1", + "value": "value_1" + } + ] + } + + ## JSON.stringify(my_dictionary, "...") + { + ..."name": "my_dictionary", + ..."version": "1.0.0", + ..."entities": [ + ......{ + ........."name": "entity_0", + ........."value": "value_0" + ......}, + ......{ + ........."name": "entity_1", + ........."value": "value_1" + ......} + ...] } [/codeblock] </description> |