hs

Строка, содержащая каталог конфигурации Hammerspoon. Обычно ~/.hammerspoon/

Строка, содержащая полный путь к файлу docs.json внутри пакета приложения Hammerspoon. Он содержит полную документацию API Hammerspoon и может быть доступен в Консоли с помощью help("someAPI"). Его также можно загрузить и обработать с помощью расширения hs.doc

Таблица, содержащая только для чтения информацию о текущем экземпляре приложения Hammerspoon.

Необязательная функция, которая будет вызываться при изменении состояния Доступности.

• Функция не будет получать никаких аргументов при вызове. Чтобы проверить, на что было изменено состояние доступности, необходимо вызвать hs.accessibilityState изнутри вашей функции.

Сбор вариантов автозаполнения для окна Консоли

• Hammerspoon предоставляет реализацию по умолчанию для этой функции, которая может дополнять глобальное пространство имен Lua, пространство имен 'hs' (то есть расширение) и метатаблицы объектов. Вы можете назначить новую функцию переменной, чтобы заменить ее своей реализацией.

Необязательная функция, которая будет вызываться при щелчке по пиктограмме Hammerspoon в доке во время работы приложения.

• Если задано, этот обратный вызов будет вызван независимо от того, отображает ли Hammerspoon окно консоли в ответ на щелчок (что можно включить/отключить с помощью hs.openConsoleOnDockClick())

Необязательная функция, которая будет вызвана при перетаскивании файлов на значок Hammerspoon в Dock или отправке через меню «Сервисы»

• Функция должна принимать один параметр, который будет строкой, содержащей полный путь к файлу, перетащенному на значок Dock.
• Если отправляются несколько файлов, этот обработчик вызывается один раз для каждого файла.
• Этот обработчик будет срабатывать при перетаскивании ЛЮБОГО типа файла на значок Hammerspoon в Dock, однако некоторые типы файлов также обрабатываются Hammerspoon отдельно. Например, hs.urlevent будет вызываться при падении следующих типов файлов на значок Dock: HTML-документы (.html, .htm, .shtml, .jhtml), текстовые документы (.txt, .text), веб-сайты (.url), XHTML-документы (.xhtml, .xht, .xhtm, .xht).

Необязательная функция, которая вызывается при уничтожении среды Lua (либо из-за выхода Hammerspoon, либо из-за перезагрузки его конфигурации)

• Эта функция не должна выполнять асинхронные задачи
• Вам не нужно тщательно уничтожать созданные вами объекты; этот обработчик существует исключительно для целей удобства (например, для сериализации состояния, уничтожения системных ресурсов, которые не будут освобождены стандартными процессами сбора мусора Lua, и т. д.)

Необязательная функция, которая вызывается при перетаскивании текста на значок Hammerspoon в Dock или отправке через меню «Сервисы»

• Функция должна принимать один параметр, который будет строкой, содержащей текст, перетащенный на значок Dock

Проверяет разрешения на доступность для Hammerspoon и, при необходимости, позволяет запросить разрешения.

• shouldPrompt - необязательное булево значение, указывающее, следует ли отображать диалоговое окно, спрашивающее о необходимости открытия приложения «Системные настройки», если доступность для Hammerspoon в настоящее время не включена. По умолчанию значение false.

• True или False, указывающие, включена ли доступность для Hammerspoon.

• Поскольку эта проверка выполняется автоматически при загрузке Hammerspoon, она, вероятно, малопригодна, за исключением случаев пропуска действий, которые, как известно, завершаются неудачей, когда доступность не включена. Например, evettaps, которые пытаются захватить события keyUp и keyDown, потерпят неудачу, пока доступность не будет включена, и приложение Hammerspoon не будет перезапущено.

Установить или отобразить, разрешены ли внешние команды Hammerspoon AppleScript.

• state - необязательное булево значение, которое установит, разрешены ли внешние команды AppleScript Hammerspoon.

• Булево значение, true если команды AppleScript Hammerspoon разрешены (или только что были разрешены), в противном случае false.

• Доступ к AppleScript по умолчанию запрещен.
• Однако из-за способа работы поддержки AppleScript Hammerspoon всегда будет разрешать команды AppleScript, которые являются частью «Стандартного набора», например, name, quit, version, и т. д. Тем не менее, Hammerspoon будет разрешать команды из «Набора Hammerspoon» только если hs.allowAppleScript() установлено в true.
• Полный список команд AppleScript:
  • Открыть /Applications/Utilities/Script Editor.app
  • Нажать File > Open Dictionary...
  • Выбрать Hammerspoon из списка приложений
  • Это откроет словарь, содержащий все доступные команды Hammerspoon AppleScript.
• Обратите внимание, что строки в коде Lua, передаваемые из AppleScript, могут быть ограничены [[ и ]] вместо обычных кавычек
• Пример:

  tell application "Hammerspoon"
    execute lua code "hs.alert([[Hello from AppleScript]])"
  end tell```
  

Установить или отобразить состояние запуска Hammerspoon при входе в систему.

• state - необязательное булево значение, которое устанавливает, должен ли Hammerspoon запускаться автоматически при входе в систему.

• True, если Hammerspoon в настоящее время (или только что был) настроен на автоматический запуск при входе в систему, или False, если нет.

Получение и, при необходимости, установка параметра Hammerspoon для автоматической проверки обновлений.

• setting - необязательная булева переменная, указывающая, должен ли Hammerspoon (true) или не должен (false) проверять наличие обновлений.

• Текущее (или только что установленное) значение, указывающее, следует ли проверять Hammerspoon на наличие обновлений.

• Если вы используете нерелизную или локально скомпилированную версию Hammerspoon, результат работы этой функции не определен.

Проверка разрешений камеры для Hammerspoon и, при необходимости, предоставление возможности запросить разрешения.

• shouldPrompt - необязательное булево значение, указывающее, следует ли запросить доступ к камере. По умолчанию значение false.

• true или false, указывающие, разрешен ли доступ к камере для Hammerspoon.

• На macOS 10.13 или более ранних версиях всегда возвращает true.

Возвращает булево значение, указывающее, доступна ли библиотека Sparkle для проверки обновлений Hammerspoon.

• Нет

• Булево значение, указывающее, доступна ли библиотека Sparkle для проверки обновлений Hammerspoon.

• Библиотека Sparkle включена во все стандартные релизы Hammerspoon, но не включена, если вы используете нерелизную или локально скомпилированную версию Hammerspoon. Поэтому эта функция может использоваться как простая проверка, чтобы определить, используете ли вы официальный релиз Hammerspoon или нет.

Немедленная проверка наличия обновлений и, при обнаружении обновления, запрос у пользователя продолжить процесс обновления.

• silent - Необязательный boolean. Если значение true, то интерфейс не будет отображен, если доступно обновление. По умолчанию значение false.

• Нет

• Если вы используете нерелизную или локально скомпилированную версию Hammerspoon, результат работы этой функции не определен.

Возвращает копию входной строки, которая может быть отображена в консоли Hammerspoon. Неверные последовательности UTF8 преобразуются в универсальный символ замены, а NULL (0x00) преобразуется в универсальный символ пустого множества.

• inString - строка для очистки

• outString - очищенная версия входной строки.

• Эта функция автоматически применяется ко всему выводу, который отображается в консоли Hammerspoon, но не к выводу, предоставленному инструментом командной строки hs.
• Эта функция не изменяет исходную строку. Чтобы фактически заменить ее, присвойте результат этой функции исходной строке.
• Эта функция представляет собой более специализированную версию функции hs.utf8.fixUTF8(...).

Закрывает окно консоли Hammerspoon

• None

• None

Закрывает окно настроек Hammerspoon

• None

• None

Устанавливает или отображает, всегда ли консоль Hammerspoon находится поверх других окон при отображении.

• state - необязательный булевый параметр, который установит, будет ли консоль Hammerspoon всегда поверх других окон при отображении.

• True, если консоль в настоящее время установлена (или только что была установлена) для всегда нахождения поверх других окон при отображении, или False, если это не так.

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

• delay - необязательное число, по умолчанию hs.math.minFloat, указывающее количество секунд с момента выполнения этой функции, для которых должно быть запланировано coroutine.resume.

• None

• Эта функция вернет ошибку, если вызвана вне корутины.

• В отличие от coroutine.yield, эта функция не позволяет передавать (новые) данные корутине или из неё во время её работы; эта функция предназначена для того, чтобы позволить длительно работающим задачам уступать время приложению Hammerspoon, чтобы другие таймеры и запланированные события могли происходить без необходимости программисту добавлять код для явного возобновления.

• Эта функция добавлена в библиотеку lua coroutine как coroutine.applicationYield в качестве альтернативного имени.

Устанавливает или отображает, виден ли значок Hammerspoon в док-панели.

• state - необязательный булевый параметр, который установит, должен ли значок Hammerspoon в док-панели быть видимым.

• True, если значок в настоящее время установлен (или только что был установлен) на отображение, или False, если он не отображается.

• Эта функция является оболочкой функций, найденных в модуле hs.dockicon , но предоставляется здесь, чтобы обеспечить интерфейс, согласованный с другими пунктами настроек, которые можно выбрать.

Выполняет команду оболочки, при необходимости сначала загружая среду пользователя оболочки, и возвращает stdout как строку, а также те же коды возврата, что и os.execute.

• command - строка, содержащая команду оболочки для выполнения
• with_user_env - необязательный булевый аргумент, который, если указан и равен true, выполняет команду в пользовательской оболочке входа в систему как «интерактивную» оболочку входа в систему, что вызывает загрузку профиля пользователя (или других скриптов входа в систему) в первую очередь.

• output -- вывод stdout команды в виде строки. Может содержать дополнительную завершающую новую строку (\n).
• status -- true если команда завершилась успешно, или nil в противном случае.
• type -- строковое значение "exit" или "signal", указывающее, завершила ли команда работу самостоятельно или была завершена сигналом (убита, ошибка сегментации и т. д.).
• rc -- если команда завершилась самостоятельно, то это число будет представлять код завершения (обычно 0 для успеха, а не 0 для ошибки, хотя это сильно зависит от команды, поэтому проверяйте страницы справки man при возникновении вопросов). Если команда была убита сигналом, то это число соответствует типу сигнала, который привел к завершению команды.

• Установление with_user_env в значение true влечет за собой заметную нагрузку, поэтому следует использовать его только при необходимости (для установки пути или других переменных среды).
• Поскольку эта функция возвращает stdout в качестве своего первого возвращаемого значения, она не является полной заменой для os.execute. В большинстве случаев вероятно, что stdout будет пустой строкой, когда status равно nil, но это не гарантировано, поэтому такой компромисс по смещению результатов os.execute был сочтен приемлемым.
• Эта конкретная функция наиболее полезна, когда вы больше заинтересованы в выводе команды, чем в простом проверке завершения и кодах возврата. Если вам нужны только коды возврата или проверка завершения команды, то os.execute будет немного эффективнее.
• Если вам нужно выполнять команды, имеющие пробелы в путях, используйте форму, подобную: hs.execute [["/Some/Path To/An/Executable" "--first-arg" "second-arg"]]

Делает Hammerspoon приложением переднего плана.

• None

• None

Получает метатаблицу Lua для объектов, созданных расширением.

• name - Строка, содержащая имя модуля, для которого требуется получить метаданные объекта (например, "hs.screen").

• Метатаблица объекта расширения или nil, если произошла ошибка

Выводит документацию по некоторым частям API Hammerspoon и Lua 5.3. Эта функция фактически взята из hs.doc.help.

• identifier - Строка, содержащая подпись какой-либо части API Hammerspoon (например, "hs.reload")

• Ничего

• Эта функция в основном предназначена для получения справки по API во время работы с консолью Hammerspoon
• Вы также можете получить результаты этой функции, используя следующие методы из консоли:
  • help("identifier") -- нужны кавычки, например, help("hs.reload")
  • help.identifier.path -- кавычки не нужны, например, help.hs.reload
• Информация по Lua может быть получена, используя префикс lua, а не hs.
  • идентификатор lua._man предоставляет оглавление руководства по Lua 5.3. Вы можете получить доступ к определённому разделу руководства по Lua, указав главу (и подглаву) следующим образом: lua._man._3_4_8.
  • идентификатор lua._C предоставляет информацию конкретно о Lua C API для использования при разработке модулей, требующих внешних библиотек.

Отображает документацию API Hammerspoon в веб-браузере.

• identifier - Необязательная строка, содержащая подпись какой-либо части API Hammerspoon (например, "hs.reload"). Если строка не указана, отображается оглавление документации Hammerspoon.

• Ничего

• Вы также можете получить результаты этой функции, используя следующие методы из консоли:
  • hs.hsdocs.identifier.path -- кавычки не нужны, например, hs.hsdocs.hs.reload
• См. hs.doc.hsdocs для получения дополнительной информации о доступных параметрах для просмотра документации.
• Эта функция предоставляет документацию по модулям, функциям и методам Hammerspoon, аналогично Hammerspoon Dash docset, но не требует дополнительного программного обеспечения.
• В настоящее время она предоставляет документацию только для встроенных модулей, функций и методов Hammerspoon. Документация Lua и модули сторонних разработчиков пока не поддерживаются, но могут быть добавлены в будущих релизах.

Загружает ложку

• name - Название ложки (без заключительного .spoon)
• global - Необязательный булевый параметр. Если true, эта функция вставит ложку в глобальное пространство имен Lua как spoon.NAME. По умолчанию true.

• Объект, предоставленный ложкой (который можно игнорировать, если вы выбрали сделать ложку глобальной)

• Ложки — это способ распространения автономных блоков функциональности Lua для Hammerspoon. Дополнительная информация: https://github.com/Hammerspoon/hammerspoon/blob/master/SPOONS.md
• Эта функция загрузит ложку и вызовет её метод :init() , если он есть. Если вы этого не хотите, или хотите использовать ложку, которая каким-то образом не соответствует поведению этой функции, вы также можете просто require('name') для загрузки ложки
• Если у ложки есть метод :start() , вы ответственны за его вызов перед использованием функциональности ложки.
• Если ложка предоставляет документацию, она будет загружена и доступна в hs.docs
• Чтобы узнать, как распространять свой код как ложку, см. https://github.com/Hammerspoon/hammerspoon/blob/master/SPOONS.md

Устанавливает или отображает видимость значка меню Hammerspoon.

• state - необязательный булевый параметр, устанавливающий видимость значка меню Hammerspoon.

• True, если значок сейчас (или только что) установлен на видимый, или False, если он не видимый.

Проверяет разрешения на микрофон для Hammerspoon и, по желанию, позволяет запросить разрешения.

• shouldPrompt - необязательное булево значение, указывающее, следует ли запросить доступ к микрофону. По умолчанию false.

• true или false , указывающие, разрешён ли доступ к микрофону для Hammerspoon.

• Всегда возвращает true в macOS 10.13 или более ранних версиях.

Открывает файл так, как будто он открывается с помощью /usr/bin/open

• filePath - Строка, содержащая путь к файлу/пакету для открытия

• Булево значение, true, если файл был успешно открыт, иначе false

Отображает окно «О программе» OS X для Hammerspoon; неявно фокусирует Hammerspoon.

• Ничего

• Ничего

Открывает окно консоли Hammerspoon и, по желанию, фокусирует его.

• bringToFront - если true (по умолчанию), консоль будет и открыта, и сфокусирована.

• Ничего

Устанавливает или отображает, будет ли открываться окно консоли при щелчке по значку Hammerspoon в Dock.

• state - Необязательный булевый параметр, true, если окно консоли должно открываться, false — если нет

• Булево значение, true, если окно консоли откроется при щелчке по значку Dock

• Это относится только к нажатиям на значок Dock, когда Hammerspoon уже запущен. Окно консоли не открывается при запуске приложения.

Отображает панель настроек Hammerspoon; неявно фокусирует Hammerspoon.

• Ничего

• Ничего

Устанавливает или отображает, будет ли панель настроек отображаться в тёмном режиме.

• state - необязательный булевый параметр, устанавливающий, будет ли панель настроек отображаться в тёмном режиме.

• Булево значение, true, если тёмный режим включён, иначе false.

Выводит форматированные строки в консоль

• format - Строка формата
• ... - Ноль или более аргументов для заполнения заполнитель в строке формата

• Ничего

• Это простой обертка вокруг кода Lua print(string.format(...)).

Оригинальная функция Lua print()

• aString - Строка для вывода

• Ничего

• Hammerspoon переопределяет функцию Lua print(), но это ссылка, которую мы сохраняем, на случай, если вам понадобится она по какой-либо причине

Выход и перезапуск Hammerspoon.

• Ничего

• Ничего

Перезагрузка вашего файла init в новой среде Lua.

• Ничего

• Ничего

Проверка разрешений на запись экрана для Hammerspoon и, по желанию, возможность запросить разрешения.

• shouldPrompt - необязательное булево значение, указывающее, должен ли отображаться диалоговое окно с запросом о том, следует ли открыть приложение "Системные настройки", когда запись экрана для Hammerspoon не включена. По умолчанию false.

• True или False, указывающие, включена ли запись экрана для Hammerspoon.

• Если вы вызовете запрос и пользователь его отклонит, вы больше не сможете его вызвать - пользователь должен вручную включить его в "Системные настройки".

Отображение ошибки пользователю с помощью консоли Hammerspoon

• err - Строка, содержащая сообщение об ошибке

• Ничего

• Эта функция вызывается всякий раз, когда возникает (неперехваченная) ошибка или она выбрасывается (через error())
• По умолчанию реализация отображает уведомление, открывает консоль, выводит сообщение об ошибке и стек вызовов
• Вы можете переопределить эту функцию, если хотите обрабатывать ошибки по-другому (например, для удаленных систем)

Переключает видимость консоли

• Ничего

• Ничего

• Если консоль в данный момент не открыта, она будет открыта. Если она открыта, но не является активным окном, она будет выведена вперёд и получит фокус.
• Если консоль активна, она будет закрыта.

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

• Ничего

• Строка, содержащая отображаемую версию последней версии, или логическое значение false, если обновление недоступно
• Строка, содержащая номер сборки последней версии, или nil если обновление недоступно

• Это не проверка в реальном времени, это кэшированный результат того, что обнаружила предыдущая проверка обновлений. По умолчанию Hammerspoon проверяет наличие обновлений каждые несколько часов, но вы также можете добавить свой таймер, чтобы проверять наличие обновлений чаще, используя hs.checkForUpdates()

Получение или установка предпочтения "Загрузка данных о сбоях" для Hammerspoon

• state - Необязательное булево значение, true для загрузки отчетов о сбоях, false для отказа

• True, если Hammerspoon в настоящее время (или только что) настроен на загрузку данных о сбоях, или False в противном случае

• Если это возможно, пожалуйста, разрешите Hammerspoon загружать отчеты о сбоях, это значительно помогает в поддержании стабильности Hammerspoon
• Наша политика конфиденциальности находится здесь: https://www.hammerspoon.org/privacy.html