updated readme

Author: cryi

README.md

@@ -16,21 +16,27 @@ Ported from [hjson-py](https://github.com/hjson/hjson-py). Inspired by rxi - [js
 Library exports json.lua like and JS like api.
 
 - Lua object to HJSON - returns HJSON string
-  - `encode(obj, indent, skipkeys)` 
-  - `stringify(obj, indent, skipkeys)`
+  - `encode(obj, options)` 
+  - `stringify(obj, options)`
   - Parameters:
     - `obj` - Lua object - `table`, `string`, `number`, `nil`, `boolean`
-    - `indent` - default `"    "`. Accepts string of whitespace characters or a number representing number of spaces (non indented HJSON is JSON, automatically forwards to `_to_json` version)
-    - `skipkeys` - default `true`  Skips invalid keys. If false throws error on invalid key.
-      - Valid key types: `boolean`, `nil`, `string`
+    - `options` table with following values:
+      - `indent` - default `"    "`. Accepts string of whitespace characters or a number representing number of spaces (non indented HJSON is JSON, automatically forwards to `_to_json` version)
+      - `skipkeys` - default `true`  Skips invalid keys. If false throws error on invalid key.
+        - Valid key types: `boolean`, `nil`, `string`
+      - `item_sort_key` - sort function which is passed to `table.sort` sorting object keys 
+      - `invalidObjectsAsType` if true functions and others objects are replaced with their type name in format `__lua_<type>` e.g. `__lua_function`
 - Lua object to JSON - returns JSON string
-  - `encode(obj, indent, skipkeys)` 
-  - `stringify(obj, indent, skipkeys)`
+  - `encode(obj, options)` 
+  - `stringify(obj, options)`
   - Parameters:
     - `obj` - Lua object - `table`, `string`, `number`, `nil`, `boolean`
-    - `indent` - default `"    "`. Accepts string of whitespace characters or a number representing number of spaces
-    - `skipkeys` - default `true`  Skips invalid keys. If false throws error on invalid key.
-      - Valid key types: `boolean`, `nil`, `string`
+    - `options` table with following values:
+      - `indent` - default `"    "`. Accepts string of whitespace characters or a number representing number of spaces (non indented HJSON is JSON, automatically forwards to `_to_json` version)
+      - `skipkeys` - default `true`  Skips invalid keys. If false throws error on invalid key.
+        - Valid key types: `boolean`, `nil`, `string`
+      - `item_sort_key` - sort function which is passed to `table.sort` sorting object keys 
+      - `invalidObjectsAsType` if true functions and others objects are replaced with their type name in format `__lua_<type>` e.g. `__lua_function`
 - H/JSON to Lua object - returns Lua object
     - `decode(str, strict, object_hook, object_pairs_hook)`
     - `parse(str, strict, object_hook, object_pairs_hook)`

hjson/encoder.lua

@@ -47,10 +47,9 @@ function JsonEncoder:new(options)
   if type(options) ~= "table" then
     options = {}
   end
-  local indent, skipkeys, sort_keys, item_sort_key, invalidObjectsAsType =
+  local indent, skipkeys, item_sort_key, invalidObjectsAsType =
     options.indent,
     options.skipkeys,
-    options.sort_keys,
     options.item_sort_key,
     options.invalidObjectsAsType
 
@@ -153,17 +152,15 @@ function JsonEncoder:new(options)
         keysetMap[key] = k
       end
     end
-    if sort_keys then
-      if type(item_sort_key) == "function" then
-        table.sort(keyset, item_sort_key)
-      else
-        table.sort(
-          keyset,
-          function(a, b)
-            return a:upper() < b:upper()
-          end
-        )
-      end
+    if type(item_sort_key) == "function" then
+      table.sort(keyset, item_sort_key)
+    else
+      table.sort(
+        keyset,
+        function(a, b)
+          return a:upper() < b:upper()
+        end
+      )
     end
     local buf = "{" .. newlineIndent
     for i, sk in ipairs(keyset) do

hjson/encoderH.lua

@@ -114,10 +114,9 @@ function HjsonEncoder:new(options)
     if type(options) ~= "table" then
         options = {}
     end
-    local indent, skipkeys, sort_keys, item_sort_key, invalidObjectsAsType =
+    local indent, skipkeys, item_sort_key, invalidObjectsAsType =
         options.indent,
         options.skipkeys,
-        options.sort_keys,
         options.item_sort_key,
         options.invalidObjectsAsType
 
@@ -249,17 +248,15 @@ function HjsonEncoder:new(options)
                 keysetMap[key] = k
             end
         end
-        if sort_keys then
-            if type(item_sort_key) == "function" then
-                table.sort(keyset, item_sort_key)
-            else
-                table.sort(
-                    keyset,
-                    function(a, b)
-                        return a:upper() < b:upper()
-                    end
-                )
-            end
+        if type(item_sort_key) == "function" then
+            table.sort(keyset, item_sort_key)
+        else
+            table.sort(
+                keyset,
+                function(a, b)
+                    return a:upper() < b:upper()
+                end
+            )
         end
         local buf = "{" .. newlineIndent
         for i, sk in ipairs(keyset) do