@marsgames/nosleep.js

NoSleep.js

Prevent display sleep and enable wake lock in all Android and iOS web browsers.

Installation

This package is published to npm as @marsgames/nosleep.js and can be installed with:

npm install @marsgames/nosleep.js

Build from source

Install all development dependencies with:

npm install

To build this library run:

npm run build

Usage

Import ES6 module:

import NoSleep from '@marsgames/nosleep.js';

Create a new NoSleep object and then enable or disable it when needed.

To create a new NoSleep object:

var noSleep = new NoSleep();

To enable wake lock:

NOTE: This function call must be wrapped in a user input event handler e.g. a mouse or touch handler*

// Enable wake lock.
// (must be wrapped in a user input event handler e.g. a mouse or touch handler)
document.addEventListener('click', function enableNoSleep() {
  document.removeEventListener('click', enableNoSleep, false);
  noSleep.enable();
}, false);

To disable wake lock:

// Disable wake lock at some point in the future.
// (does not need to be wrapped in any user input event handler)
noSleep.disable();

Feedback

If you find any bugs or issues please report them on the NoSleep.js Issue Tracker.

If you would like to contribute to this project please consider forking this repo, making your changes and then creating a new Pull Request back to the main code repository.

License

Original author: MIT. Copyright (c) Rich Tibbett.

See the LICENSE file.