Spec-Zone.ru › Hammerspoon

hs.settings

Сериализуйте простые переменные Lua между запусками Hammerspoon. Параметры должны иметь строковый ключ и состоять из сериализуемых объектов Lua (строка, число, булево, nil, таблицы таких и т. д.).

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

Обзор API

  • Константы — полезные значения, которые нельзя изменить
    • bundleID
    • dateFormat
  • Функции — API-вызовы, предоставляемые напрямую расширением
    • clear
    • get
    • getKeys
    • set
    • setData
    • setDate
    • watchKey

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

Константы

bundleID
Подпись hs.settings.bundleID
Тип Константа
Описание

Строка, представляющая идентификатор пакета, в котором хранятся настройки Hammerspoon. Вы можете использовать его с командной утилитой defaults или другими инструментами, которые позволяют получить доступ к User Defaults приложений, чтобы получить доступ к ним вне Hammerspoon.

Источник extensions/settings/libsettings.m строка 326
dateFormat
Подпись hs.settings.dateFormat
Тип Константа
Описание

Строка, представляющая ожидаемый формат даты и времени при представлении даты и времени в виде строки для hs.setDate(). Например, os.date(hs.settings.dateFormat)

Источник extensions/settings/libsettings.m строка 320

Функции

clear
Подпись hs.settings.clear(key) -> bool
Тип Функция
Описание

Удаляет параметр.

Параметры
  • key — строка, содержащая имя параметра
Возвращает
  • Булево значение, true, если параметр был удален, иначе false
Источник extensions/settings/libsettings.m строка 179
get
Подпись hs.settings.get(key) -> string or boolean or number or nil or table or binary data
Тип Функция
Описание

Загружает параметр.

Параметры
  • key — строка, содержащая имя параметра
Возвращает
  • Значение параметра
Примечания
  • Эта функция может загружать все типы данных, поддерживаемые hs.settings.set(), hs.settings.setData() и hs.settings.setDate().
Источник extensions/settings/libsettings.m строка 157
getKeys
Подпись hs.settings.getKeys() -> table
Тип Функция
Описание

Получает все ранее сохраненные имена параметров.

Параметры
  • Нет
Возвращает
  • Таблица, содержащая все ключи параметров в настройках Hammerspoon
Примечания
  • Используйте ipairs(hs.settings.getKeys()) для перебора всех доступных параметров.
  • Используйте hs.settings.getKeys()["someKey"] для проверки существования определенного ключа.
Источник extensions/settings/libsettings.m строка 200
set
Подпись hs.settings.set(key[, val])
Тип Функция
Описание

Сохраняет параметр с распространенными типами данных.

Параметры
  • key — строка, содержащая имя параметра
  • val — необязательное значение параметра. Допустимые типы данных:
    • строка
    • число
    • булево
    • nil
    • таблица (которая может содержать любые из тех же допустимых типов данных)
Возвращает
  • Нет
Примечания
  • Если параметр val не указан, предполагается, что он равен nil
  • Эта функция не может задавать даты или типы данных с сырыми данными, см. hs.settings.setDate() и hs.settings.setData()
  • Установка значения nil эквивалентна очистке значения с помощью hs.settings.clear
Источник extensions/settings/libsettings.m строка 49
setData
Подпись hs.settings.setData(key, val)
Тип Функция
Описание

Сохраняет параметр с сырыми данными.

Параметры
  • key — строка, содержащая имя параметра
  • val — некоторые сырые данные
Возвращает
  • Нет
Источник extensions/settings/libsettings.m строка 91
setDate
Подпись hs.settings.setDate(key, val)
Тип Функция
Описание

Сохраняет параметр с датой.

Параметры
  • key — строка, содержащая имя параметра
  • val — число, представляющее секунды с момента 1970-01-01 00:00:00 +0000 (например, os.time()), или строка, содержащая дату в формате RFC3339 (YYYY-MM-DD[T]HH:MM:SS[Z])
Возвращает
  • Нет
Примечания
  • См. hs.settings.dateFormat для удобного представления формата RFC3339, чтобы использовать его с другими функциями, связанными с датой/временем
Источник extensions/settings/libsettings.m строка 129
watchKey
Подпись hs.settings.watchKey(identifier, key, [fn]) -> identifier | current value
Тип Функция
Описание

Получить или установить наблюдателя для вызова обратного вызова при изменении указанного ключа настроек.

Параметры
  • identifier — необходимая строка, используемая в качестве идентификатора для этого обратного вызова
  • key — ключ настроек, за изменением которого нужно наблюдать
  • fn — функция обратного вызова, которая должна вызываться при изменении указанного ключа. Если это явный nil, удаляет существующий обратный вызов.
Возвращает
  • если обратный вызов устанавливается или удаляется, возвращает идентификатор; в противном случае возвращает текущую функцию обратного вызова или nil, если функция обратного вызова в данный момент не определена.
Примечания
  • идентификатор необходим для регистрации нескольких обратных вызовов для одного и того же ключа разными модулями; его значение не влияет на то, за чем ведется наблюдение, но должно быть уникальным для нескольких наблюдателей одного и того же ключа.
  • Не работает с ключами, которые содержат точку (.) в имени ключа, потому что KVO использует нотацию точек для указания последовательности свойств. Если вам известно, как экранировать точки, чтобы они были доступны в качестве имен ключей NSUserDefaults, пожалуйста, создайте вопрос и поделитесь информацией!
Источник extensions/settings/libsettings.m строка 230

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

Spec-Zone.ru

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