Spec-Zone.ru › Hammerspoon

hs.json

Кодирование и декодирование JSON

Этот модуль частично основан на коде из предыдущей версии Mjolnir от Steven Degutis.

Обзор API

  • Функции - API-вызовы, предлагаемые непосредственно расширением
    • decode
    • encode
    • read
    • write

Документация API

Функции

decode
Подпись hs.json.decode(jsonString) -> table
Тип Функция
Описание

Декодирует JSON в таблицу

Параметры
  • jsonString - строка, содержащая данные JSON
Возвращает
  • Таблица, представляющая предоставленные данные JSON
Примечания
  • Это полезно для извлечения некоторых более сложных структур таблиц Lua в качестве постоянных настроек (см. hs.settings)
Исходный код extensions/json/libjson.m строка 139
encode
Подпись hs.json.encode(val[, prettyprint]) -> string
Тип Функция
Описание

Кодирует таблицу в JSON

Параметры
  • val - таблица, содержащая данные, которые нужно закодировать в JSON
  • prettyprint - необязательный логический параметр, true для форматирования JSON для удобства чтения, false для форматирования JSON для экономии места. По умолчанию false
Возвращает
  • Строка, содержащая представление JSON предоставленной таблицы
Примечания
  • Это полезно для хранения некоторых более сложных структур таблиц Lua в качестве постоянных настроек (см. hs.settings)
Исходный код extensions/json/libjson.m строка 112
read
Подпись hs.json.read(path) -> table | nil
Тип Функция
Описание

Декодирует файл JSON в таблицу.

Параметры
  • path - путь и имя файла JSON для чтения.
Возвращает
  • Таблица, представляющая предоставленные данные JSON, или nil в случае ошибки.
Исходный код extensions/json/libjson.m строка 197
write
Подпись hs.json.write(data, path, [prettyprint], [replace]) -> boolean
Тип Функция
Описание

Кодирует таблицу как JSON в файл

Параметры
  • data - таблица, содержащая данные, которые нужно закодировать в JSON
  • path - путь и имя файла JSON, в который нужно записать
  • prettyprint - необязательный логический параметр, true для форматирования JSON для удобства чтения, false для форматирования JSON для экономии места. По умолчанию false.
  • replace - необязательный логический параметр, true для замены существующего файла по тому же пути, если он существует. По умолчанию false
Возвращает
  • true в случае успеха, иначе false в случае ошибки
Исходный код extensions/json/libjson.m строка 164

© 2014–2017 Hammerspoon contributors
Licensed under the MIT License.
https://www.hammerspoon.org/docs/hs.json.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API