Spec-Zone.ru › Hammerspoon

hs.timer.delayed

Специализированные объекты таймера для объединения обработки непредсказуемых асинхронных событий в один обратный вызов

Обзор API

  • Конструкторы — вызовы API, которые возвращают объект, как правило, с методами API
    • new
  • Методы — вызовы API, которые могут быть выполнены только на объекте, возвращённом конструктором
    • nextTrigger
    • running
    • setDelay
    • start
    • stop

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

Конструкторы

new
Подпись hs.timer.delayed.new(delay, fn) -> hs.timer.delayed object
Тип Конструктор
Описание

Создаёт новый таймер с задержкой

Параметры
  • delay — количество секунд ожидания после вызова :start(), (счётчик обратного отсчёта до обратного вызова)
  • fn — функция, которая будет вызвана после того, как delay полностью истечёт без дальнейших вызовов :start()
Возвращает
  • новый объект hs.timer.delayed
Примечания
  • Эти таймеры предназначены для длительного использования: после создания их нельзя удалить из цикла выполнения; создайте их один раз на уровне модуля.
  • Таймеры с задержкой имеют специализированные методы, которые ведут себя иначе, чем обычные таймеры. Когда вызывается метод :start(), таймер будет ждать delay секунд, прежде чем вызвать fn(); это называется отсчётом обратного отсчёта до обратного вызова. Если :start() вызывается снова, прежде чем delay истечёт, отсчёт обратного отсчёта начинается заново.
  • Вы можете использовать таймер с задержкой для объединения обработки непредсказуемых асинхронных событий в один обратный вызов; например, если у вас есть поток событий, которые происходят «вспышками» по несколько десятков событий сразу, установите подходящую delay для ожидания стабилизации ситуации, а затем ваш обратный вызов будет выполнен только один раз.
Источник extensions/timer/timer.lua строка 328

Методы

nextTrigger
Подпись hs.timer.delayed:nextTrigger() -> number or nil
Тип Метод
Описание

Возвращает оставшееся время в счётчике обратного отсчёта до обратного вызова

Параметры
  • Никаких
Возвращает
  • если счётчик обратного отсчёта работает, возвращает количество секунд до срабатывания; в противном случае возвращает nil
Источник extensions/timer/timer.lua строка 318
running
Подпись hs.timer.delayed:running() -> boolean
Тип Метод
Описание

Возвращает логическое значение, указывающее, работает ли счётчик обратного отсчёта до обратного вызова

Параметры
  • Никаких
Возвращает
  • логическое значение
Источник extensions/timer/timer.lua строка 295
setDelay
Подпись hs.timer.delayed:setDelay(delay) -> hs.timer.delayed object
Тип Метод
Описание

Изменяет продолжительность отсчёта обратного отсчёта до обратного вызова

Параметры
  • Никаких
Возвращает
  • объект таймера с задержкой
Примечания
  • если счётчик обратного отсчёта работает, вызов этого метода перезапустит его
Источник extensions/timer/timer.lua строка 305
start
Подпись hs.timer.delayed:start([delay]) -> hs.timer.delayed object
Тип Метод
Описание

Запускает или перезапускает отсчёт обратного отсчёта до обратного вызова

Параметры
  • delay — (необязательно) если указано, устанавливает продолжительность отсчёта обратного отсчёта на это количество секунд только для этого времени; последующие вызовы :start() вернутся к исходной задержке (или к задержке, заданной с помощью :setDelay(delay))
Возвращает
  • объект таймера с задержкой
Источник extensions/timer/timer.lua строка 275
stop
Подпись hs.timer.delayed:stop() -> hs.timer.delayed object
Тип Метод
Описание

Отменяет отсчёт обратного отсчёта до обратного вызова, если он работает; обратный вызов, следовательно, не будет вызван

Параметры
  • Никаких
Возвращает
  • объект таймера с задержкой
Источник extensions/timer/timer.lua строка 285

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

Spec-Zone.ru

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