Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

wake-lock

Package Overview
Dependencies
Maintainers
1
Versions
2
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

wake-lock

keep your computer awake

  • 0.1.0
  • Source
  • npm
  • Socket score

Version published
Maintainers
1
Created
Source

wake-lock

😴🙅

Prevent your laptop from sleeping. (macOS only for now.)

Usage

const {WakeLock} = require('wake-lock')

const lock = new WakeLock("Reticulating splines")

// ... reticulate the splines, which process must not be interrupted ...

lock.release()

API

new WakeLock(reasonForLocking, {type: "idle" | "display"})

Creates a new wake lock which will prevent the machine from going to sleep due to idle detection until the lock is released. Forced sleep, e.g. from closing the laptop's lid or a low battery emergency, will not be prevented. Multiple wake locks are allowed: the machine will stay awake until all wake locks are released.

  • reasonForLocking String - a descriptive string used by the system whenever it needs to tell the user why the system is not sleeping. For example, "Mail Compacting Mailboxes" would be a useful string.
  • options Object (optional)
    • type "idle" | "display" - if "display" is specified, display sleep will be prevented. If "idle" is specified (the default), the display will sleep but the machine will stay awake while the lock is held.

WakeLock.release()

Releases a wake lock, allowing the machine to sleep. Calling this function on a lock that has already been released will throw an error.

Keywords

FAQs

Package last updated on 13 Mar 2019

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc