View source for ToJSON

<!-- This page is generated automatically from the function definition: toJSON. -->
= toJSON =
Serializes a supported Lua value to bounded JSON.

== Syntax ==
<syntaxhighlight lang="lua">
string|false json, string|nil error = toJSON(mixed value)
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Required !! Description
|-
| <code>value</code> || <code>mixed</code> || yes || A nil, boolean, finite number, string, or acyclic table containing supported values.
|}

== Returns ==
Returns the JSON string and <code>nil</code> on success. On failure it returns <code>false</code> and an error string.

== Examples ==
Encode a compact payload:
<syntaxhighlight lang="lua" line>
local json, errorMessage = toJSON({ playerId = playerId, ready = true })
if not json then
    outputDebugString(errorMessage)
end
</syntaxhighlight>

== Notes ==
* Available in both server-side and client-side resource scripts.
* JSON is limited to 16 KiB, 16 nested levels, and 2048 entries.

[[Category:Lua Functions]]
[[Category:Shared Functions]]
[[Category:Utility Functions]]