docs » hs.plist

Loads a Property List file

• filepath - The path and filename of a plist file to read

• The contents of the plist as a Lua table

Interprets a property list file within a string into a table.

• value - The contents of the property list as a string
• binary - an optional boolean, specifying whether the value should be treated as raw binary (true) or as an UTF8 encoded string (false). If you do not provide this argument, the function will attempt to auto-detect the type.

• The contents of the property list as a Lua table or nil if an error occurs

Writes a Property List file

• filepath - The path and filename of the plist file to write
• data - A Lua table containing the data to write into the plist
• binary - An optional boolean, if true, the plist will be written as a binary file. Defaults to false

• A boolean, true if the plist was written successfully, otherwise false

• Only simple types can be converted to plist items:
• Strings
• Numbers
• Booleans
• Tables
• You should be careful when reading a plist, modifying and writing it - Hammerspoon may not be able to preserve all of the datatypes via Lua

Interprets a property list file within a string into a table.

• data - A Lua table containing the data to write into a plist string
• binary - an optional boolean, default false, specifying that the resulting string should be encoded as a binary plist.

• A string representing the data as a plist or nil if there was a problem with the date or serialization.