json.tryDecode - Real Function Reference

json.tryDecode(json: string, options?: DecodeOptions): boolean | any | nil | string | nil | number | nil

Arguments

string

required

JSON string to parse. The function reads this argument with string type checking.

DecodeOptions

Optional decode options. A boolean sets useNull. A table can set useNull and maxDepth.

Returns

boolean

true when parsing succeeds, false when parsing fails inside the protected parse block.

any | nil

Decoded value on success. On parse failure, this return is nil.

string | nil

Error message on parse failure. The message is prefixed with json.decodeSafe and includes a near-position suffix.

number | nil

Parser byte position from the parser on parse failure. This return is only present on failure.

Types

DecodeOptions

Controls JSON parsing behavior.

Name	Type	Required	Description
`useNull`	`boolean`	No	Represents JSON null with the library’s null sentinel instead of nil.
`maxDepth`	`integer`	No	Sets the maximum nesting depth, clamped from 1 to 4096.

Example

Decode JSON with status returns using the json.decodeSafe-compatible alias.

local ok, value, message, position = json.tryDecode('{"ready":true,"missing":null}', {
    useNull = true,
})

if ok then
    print(value.ready)
    print(json.isNull(value.missing))
else
    warn(message, position)
end

​Arguments

​Returns

​Types

​DecodeOptions

​Example

Arguments

Returns

Types

DecodeOptions

Example