[ { "Command": [], "Constant": [], "Constructor": [], "Deprecated": [], "Field": [], "Function": [], "Method": [ { "def": "Caffeine:bindHotkeys(mapping)", "desc": "Binds hotkeys for Caffeine", "doc": "Binds hotkeys for Caffeine\n\nParameters:\n * mapping - A table containing hotkey modifier/key details for the following items:\n * toggle - This will toggle the state of display sleep prevention, and update the menubar graphic\n\nReturns:\n * The Caffeine object", "name": "bindHotkeys", "parameters": [ " * mapping - A table containing hotkey modifier/key details for the following items:", " * toggle - This will toggle the state of display sleep prevention, and update the menubar graphic" ], "returns": [ " * The Caffeine object" ], "signature": "Caffeine:bindHotkeys(mapping)", "stripped_doc": "", "type": "Method" }, { "def": "Caffeine:setState(on)", "desc": "Sets whether or not caffeination should be enabled", "doc": "Sets whether or not caffeination should be enabled\n\nParameters:\n * on - A boolean, true if screens should be kept awake, false to let macOS send them to sleep\n\nReturns:\n * None", "name": "setState", "parameters": [ " * on - A boolean, true if screens should be kept awake, false to let macOS send them to sleep" ], "returns": [ " * None" ], "signature": "Caffeine:setState(on)", "stripped_doc": "", "type": "Method" }, { "def": "Caffeine:start()", "desc": "Starts Caffeine", "doc": "Starts Caffeine\n\nParameters:\n * None\n\nReturns:\n * The Caffeine object", "name": "start", "parameters": [ " * None" ], "returns": [ " * The Caffeine object" ], "signature": "Caffeine:start()", "stripped_doc": "", "type": "Method" }, { "def": "Caffeine:stop()", "desc": "Stops Caffeine", "doc": "Stops Caffeine\n\nParameters:\n * None\n\nReturns:\n * The Caffeine object", "name": "stop", "parameters": [ " * None" ], "returns": [ " * The Caffeine object" ], "signature": "Caffeine:stop()", "stripped_doc": "", "type": "Method" } ], "Variable": [], "desc": "Prevent the screen from going to sleep", "doc": "Prevent the screen from going to sleep\nDownload: [https://github.com/Hammerspoon/Spoons/raw/master/Spoons/Caffeine.spoon.zip](https://github.com/Hammerspoon/Spoons/raw/master/Spoons/Caffeine.spoon.zip)", "items": [ { "def": "Caffeine:bindHotkeys(mapping)", "desc": "Binds hotkeys for Caffeine", "doc": "Binds hotkeys for Caffeine\n\nParameters:\n * mapping - A table containing hotkey modifier/key details for the following items:\n * toggle - This will toggle the state of display sleep prevention, and update the menubar graphic\n\nReturns:\n * The Caffeine object", "name": "bindHotkeys", "parameters": [ " * mapping - A table containing hotkey modifier/key details for the following items:", " * toggle - This will toggle the state of display sleep prevention, and update the menubar graphic" ], "returns": [ " * The Caffeine object" ], "signature": "Caffeine:bindHotkeys(mapping)", "stripped_doc": "", "type": "Method" }, { "def": "Caffeine:setState(on)", "desc": "Sets whether or not caffeination should be enabled", "doc": "Sets whether or not caffeination should be enabled\n\nParameters:\n * on - A boolean, true if screens should be kept awake, false to let macOS send them to sleep\n\nReturns:\n * None", "name": "setState", "parameters": [ " * on - A boolean, true if screens should be kept awake, false to let macOS send them to sleep" ], "returns": [ " * None" ], "signature": "Caffeine:setState(on)", "stripped_doc": "", "type": "Method" }, { "def": "Caffeine:start()", "desc": "Starts Caffeine", "doc": "Starts Caffeine\n\nParameters:\n * None\n\nReturns:\n * The Caffeine object", "name": "start", "parameters": [ " * None" ], "returns": [ " * The Caffeine object" ], "signature": "Caffeine:start()", "stripped_doc": "", "type": "Method" }, { "def": "Caffeine:stop()", "desc": "Stops Caffeine", "doc": "Stops Caffeine\n\nParameters:\n * None\n\nReturns:\n * The Caffeine object", "name": "stop", "parameters": [ " * None" ], "returns": [ " * The Caffeine object" ], "signature": "Caffeine:stop()", "stripped_doc": "", "type": "Method" } ], "name": "Caffeine", "stripped_doc": "Download: [https://github.com/Hammerspoon/Spoons/raw/master/Spoons/Caffeine.spoon.zip](https://github.com/Hammerspoon/Spoons/raw/master/Spoons/Caffeine.spoon.zip)", "submodules": [], "type": "Module" } ]