docs » hs.json

JSON encoding and decoding

This module is based partially on code from the previous incarnation of Mjolnir by Steven Degutis.

API Overview

API Documentation

Functions

decode
Signature hs.json.decode(jsonString) -> table
Type Function
Description Decodes JSON into a table
Parameters
  • jsonString - A string containing some JSON data
Returns
  • A table representing the supplied JSON data
Notes
  • This is useful for retrieving some of the more complex lua table structures as a persistent setting (see hs.settings)
Source extensions/json/libjson.m line 139
encode
Signature hs.json.encode(val[, prettyprint]) -> string
Type Function
Description Encodes a table as JSON
Parameters
  • val - A table containing data to be encoded as JSON
  • prettyprint - An optional boolean, true to format the JSON for human readability, false to format the JSON for size efficiency. Defaults to false
Returns
  • A string containing a JSON representation of the supplied table
Notes
  • This is useful for storing some of the more complex lua table structures as a persistent setting (see hs.settings)
Source extensions/json/libjson.m line 112
read
Signature hs.json.read(path) -> table | nil
Type Function
Description Decodes JSON file into a table.
Parameters
  • path - The path and filename of the JSON file to read.
Returns
  • A table representing the supplied JSON data, or nil if an error occurs.
Source extensions/json/libjson.m line 197
write
Signature hs.json.write(data, path, [prettyprint], [replace]) -> boolean
Type Function
Description Encodes a table as JSON to a file
Parameters
  • data - A table containing data to be encoded as JSON
  • path - The path and filename of the JSON file to write to
  • prettyprint - An optional boolean, true to format the JSON for human readability, false to format the JSON for size efficiency. Defaults to false
  • replace - An optional boolean, true to replace an existing file at the same path if one exists. Defaults to false
Returns
  • true if successful otherwise false if an error has occurred
Source extensions/json/libjson.m line 164