Provides support for parsing and stringifying JSON5.
Methods
(inner) load(callback)
Loads the library. Invokes the callback handler when complete.
Parameters:
| Name | Type | Description |
|---|---|---|
callback |
the handler to callback when the library is loaded. |
(inner) parse(textnon-null, reviveropt, non-null) → {*}
Wrapper for the JSON5 "flexible" parser that can handle real numbers sent as NaNs, Infinity etc.
The following text was taken from the JSON5.org site. See: https://json5.org.
Parses a JSON5 string, constructing the JavaScript value or object described by the string.
An optional reviver function can be provided to perform a transformation on the resulting
object before it is returned.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
text |
String | The string to parse as JSON5. | |
reviver |
Object |
<optional> |
If a function, this prescribes how the value originally produced by parsing is transformed, before being returned. |
Throws:
SyntaxError if the input string could not be parsed into a JSON object.
Returns:
the object corresponding to the given JSON5 text.
- Type
- *
(inner) stringify(value, replaceropt, spaceopt) → {string}
Wrapper for the JSON5 alternative stringifier.
The following text was taken from the JSON5.org site. See: https://json5.org.
Converts a JavaScript value to a JSON5 string, optionally replacing values if a replacer
function is specified, or optionally including only the specified properties if a replacer
array is specified.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
value |
Object | The value to convert to a JSON5 string. | |
replacer |
function |
<optional> |
A function that alters the behavior of the stringification process, or an array of String and Number objects that serve as a whitelist for selecting/filtering the properties of the value object to be included in the JSON5 string. If this value is null or not provided, all properties of the object are included in the resulting JSON5 string. |
space |
string | number |
<optional> |
A String or Number object that's used to insert white space into the output JSON5 string for readability purposes. If this is a Number, it indicates the number of space characters to use as white space; this number is capped at 10 (if it is greater, the value is just 10). Values less than 1 indicate that no space should be used. If this is a String, the string (or the first 10 characters of the string, if it's longer than that) is used as white space. If this parameter is not provided (or is null), no white space is used. If white space is used, trailing commas will be used in objects and arrays. |
Throws:
TypeError if the input JSON Object could not be turned into a string.
Returns:
A JSON5 string representing the value.
- Type
- string