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

  • Functions - API calls offered directly by the extension

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`)

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`)

results matching ""

    No results matching ""