Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

caffeinate

rogerbf21MIT1.0.1

Prevent the system from going to sleep

sleep, macOS, utility

readme

caffeinate

caffeinate is a system utility provided in macOS which prevents the system from sleeping indefinitely or on behalf of a utility.

usage

const caffeinate = require(`caffeinate`)

caffeinate({ pid: 45623 })
.then(caffeinatePid => console.log(caffeinatePid))
.catch(error => console.log(error))

api

caffeinate([options])

Spawns caffeinate. Resolves with the pid of the spawned caffeinate instance.

options can be any of those supported by caffeinate. For the sake of readability you can use timeout and pid in place of t and w respectively.

options-to-args handles the conversion of options into spawn args.