docs » Cherry

Cherry tomato (a tiny Pomodoro) -- a Pomodoro Timer for the menubar

Download: https://github.com/Hammerspoon/Spoons/raw/master/Spoons/Cherry.spoon.zip

API Overview

Methods - API calls which can only be made on an object returned by a constructor

bindHotkeys
popup
start

API Documentation

Methods

bindHotkeys

Signature	`Cherry:bindHotkeys(mapping)`
Type	Method
Description	Binds hotkeys for Cherry
Parameters	mapping - A table containing hotkey details for the following items: start - start the pomodoro timer (Default: cmd-ctrl-alt-C)
Returns
Source	Source/Cherry.spoon/init.lua line 46

popup

Signature	`Cherry:popup()`
Type	Method
Description	Popup an alert or notification when time is up.
Parameters	None
Returns	None
Source	Source/Cherry.spoon/init.lua line 93

start

Signature	`Cherry:start()`
Type	Method
Description	Starts the timer and displays the countdown in a menubar item
Parameters	resume - boolean when true resumes countdown at current value of self.timeLeft
Returns	None
Source	Source/Cherry.spoon/init.lua line 125