<h1>JSON Module for Lua</h1>

<h2>Introduction</h2>

This is a module written in
without any dependencies to other external libraries. It supports UTF-8.

<h2>Download</h2>
  *  | dkjson.lua]

<h2>Usage</h2>

The full [Documentation|documentation] is available here in the wiki or as Markdown text in the source file.

<h2>Examples</h2>

<h3>Encoding</h3>

<pre><code><nowiki>
<span class="luakeyword">local</span> json = <span class="lualibrary">require</span> (<span class="luastring">"dkjson"</span>)

<span class="luakeyword">local</span> tbl = {
  animals = { <span class="luastring">"dog"</span>, <span class="luastring">"cat"</span>, <span class="luastring">"aardvark"</span> },
  instruments = { <span class="luastring">"violin"</span>, <span class="luastring">"trombone"</span>, <span class="luastring">"theremin"</span> },
  bugs = json.null,
  trees = <span class="luakeyword">nil</span>
}

<span class="luakeyword">local</span> str = json.encode (tbl, { indent = <span class="luakeyword">true</span> })

<span class="lualibrary">print</span> (str)


<h4>Output</h4>

<pre><code><nowiki>
{
  "bugs":null,
  "instruments":["violin","trombone","theremin"],
  "animals":["dog","cat","aardvark"]
}


<h3>Decoding</h3>

<pre><code><nowiki>
<span class="luakeyword">local</span> json = <span class="lualibrary">require</span> (<span class="luastring">"dkjson"</span>)

<span class="luakeyword">local</span> str = <span class="luastring">[[
{
  "numbers": [ 2, 3, -20.23e+2, -4 ],
  "currency": "\u20AC"
}
]]</span>

<span class="luakeyword">local</span> obj, pos, err = json.decode (str, 1, <span class="luakeyword">nil</span>)
<span class="luakeyword">if</span> err <span class="luakeyword">then</span>
  <span class="lualibrary">print</span> (<span class="luastring">"Error:"</span>, err)
<span class="luakeyword">else</span>
  <span class="lualibrary">print</span> (<span class="luastring">"currency"</span>, obj.currency)
  <span class="luakeyword">for</span> i = 1,#obj.numbers <span class="luakeyword">do</span>
    <span class="lualibrary">print</span> (i, obj.numbers[i])
  <span class="luakeyword">end</span>
<span class="luakeyword">end</span>


<h4>Output</h4>

<pre><nowiki>
currency	€
1	2
2	3
3	-2023
4	-4


<h2>Versions</h2>

<h3>Version 2.3 (2013-04-14)</h3>

  *  Download | dkjson.lua version 2.3]

Changes since version 2.2:

  *  Corrected the range of escaped characters.  Among other characters
     U+2029 was missing, which would cause trouble when parsed by a
     JavaScript interpreter.
  *  Added options to register the module table in a global variable.
     This is useful in environments where functions similar to require are
     not available.

<h3>Version 1.2 (2013-04-14)</h3>

  *  Download | dkjson.lua version 1.2]

Changes since version 1.1:

  *  Corrected the range of escaped characters.  Among other characters
     U+2029 was missing, which would cause trouble when parsed by a
     JavaScript interpreter.
  *  Locations for error messages were off by one in the first line.


<h3>Version 2.2 (2012-04-28)</h3>

  *  Download | dkjson.lua version 2.2]

Changes since version 2.1:

  *  __jsontype is only used for empty tables.
  *  It is possible to decode tables without assigning metatables.
  *  Locations for error messages were off by one in the first line.
  *  There is no LPeg version of json.quotestring anymore.

<h3>Version 2.1 (2011-07-08)</h3>

  *  Download | dkjson.lua version 2.1]

Changes since version 2.0:

  *  Changed the documentation to Markdown format.
  *  LPeg is now parsing only a single value at a time to avoid running
     out of Lua stack for big arrays and objects.
  *  Read __tojson, __jsontype and __jsonorder even from blocked metatables
     through the debug module.
  *  Fixed decoding single numbers (only affected the non-LPeg mode).
  *  Corrected the range of escaped Unicode control characters.

<h3>Version 1.1 (2011-07-08)</h3>

  *  Download | dkjson.lua version 1.1]

Changes since version 1.0:

  *  The values are recognised and encoded as "null" like in
     the original JavaScript implementation.
  *  Read __tojson even from blocked metatables through the debug module.
  *  Fixed decoding single numbers.
  *  Corrected the range of escaped Unicode control characters.

<h3>Version 2.0 (2011-05-30)</h3>

  *  Download | dkjson.lua version 2.0]

Changes since version 1.0:

  *  Optional LPeg support.
  *  Invalid input data for encoding raises errors instead of returning nil
     and the error message. (Invalid data for encoding is usually a
     programming error. Raising an error removes the work of explicitly
     checking the result).
  *  The metatable field __jsontype can control whether a Lua table is
     encoded as a JSON array or object. (Mainly useful for empty tables).
  *  When decoding, two metatables are created. One is used to mark the arrays
     while the other one is used for the objects. (The metatables are
     created once for each decoding operation to make sandboxing possible.
     However, you can specify your own metatables as arguments).
  *  There are no spaces added any longer when encoding.
  *  It is possible to explicitly sort keys for encoding by providing an array with key
     names to the option "keyorder" or the metatable field __jsonorder.
  *  The values are recognised and encoded as "null" like in
     the original JavaScript implementation.

<h3>Version 1.0</h3>

Initial version, released 2010-08-28.

  *  Download | dkjson.lua version 1.0]