nosleep.js
    TypeScript icon, indicating that this package has built-in type declarations

    0.12.0 • Public • Published

    NoSleep.js

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

    Check out the live demo in any Android or iOS web browser.

    Installation

    This library is available on Bower as nosleep.

    bower install nosleep

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

    npm install nosleep.js

    Alternatively, you can manually add NoSleep.js to your project (or the minified version).

    Build from source

    Install all development dependencies with:

    npm install

    To build this library run:

    npm run build

    A new build of NoSleep.js and NoSleep.min.js will now be available in the /dist directory.

    Usage

    Import ES6 module:

    import NoSleep from '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();

    See example/index.html (and the live demo) for more information.

    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

    MIT. Copyright (c) Rich Tibbett.

    See the LICENSE file.

    Install

    npm i nosleep.js

    DownloadsWeekly Downloads

    30,259

    Version

    0.12.0

    License

    MIT

    Unpacked Size

    74.6 kB

    Total Files

    23

    Last publish

    Collaborators

    • richt