Home

Awesome

<h1 align="center">Welcome to jest-wake-lock-mock 👋</h1> <p> <img alt="npm" src="https://img.shields.io/npm/v/jest-wake-lock-mock?style=for-the-badge"> <img alt="GitHub Workflow Status" src="https://img.shields.io/github/workflow/status/jorisre/jest-wake-lock-mock/CI?style=for-the-badge"> <img alt="Codecov" src="https://img.shields.io/codecov/c/github/jorisre/jest-wake-lock-mock?style=for-the-badge&token=D75F3R5OEO"> <a href="https://github.com/jorisre/jest-wake-lock-mock/blob/master/LICENSE" target="_blank"> <img alt="License: MIT" src="https://img.shields.io/github/license/jorisre/jest-wake-lock-mock?style=for-the-badge" /> </a> <a href="https://twitter.com/_jorisre" target="_blank"> <img alt="Twitter: _jorisre" src="https://img.shields.io/twitter/follow/_jorisre.svg?style=for-the-badge" /> </a> </p>

Mock Screen Wake Lock API (navigator.wakeLock) with ease and run your tests using Jest

🏠 Homepage

Prerequisites

Install

npm i -D jest-wake-lock-mock
# or
yarn add -D jest-wake-lock-mock

Usage

In your jest.config.js or package.json under jest section create a setupFiles array and add jest-wake-lock-mock to it.

{
  setupFiles: ['jest-wake-lock-mock'],
  // jest config...
}

Tests

Write your tests with confidence using the same Screen Wake Lock API api as in the browser.

Example (More):

const requestWakeLock = async () => {
  try {
    const wakeLock = await navigator.wakeLock.request('screen');

    return { wakeLock };
  } catch (error) {
    return { error };
  }
};

test('wakeLock request with success', async () => {
  const { wakeLock, error } = await requestWakeLock(handleRelease);

  expect(error).not.toBeDefined();
  expect(wakeLock).toBeDefined();
  expect(wakeLock?.type).toEqual('screen');
  expect(wakeLock?.released).toBe(false);
});

Author

👤 Joris

🤝 Contributing

Contributions, issues and feature requests are welcome!<br />Feel free to check issues page.

Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2020 Joris.<br /> This project is MIT licensed.

This README was generated with ❤️ by readme-md-generator