Jest Environment

About

@happy-dom/jest-environment makes it possible to use Happy DOM with Jest.

Installation

npm install --save-dev @jest/environment @jest/fake-timers @jest/types @jest/mock @jest/util @happy-dom/jest-environment

Setup

Jest uses node as test environment by default. In order to tell Jest to use a different environment we will either have to set a CLI attribute, define it in "package.json" or add a property to your Jest config file.

CLI

When calling the "jest" command add --env=@happy-dom/jest-environment as an attribute.

jest --env=@happy-dom/jest-environment

In Package.json

It is possible to add the Jest config to your package.json.

{
  "jest": {
    "testEnvironment": "@happy-dom/jest-environment"
  }
}

Jest Config File

Add the snippet below to your Jest config file (usually jest.config.js).

{
  "testEnvironment": "@happy-dom/jest-environment"
}

Options

It is possible to send in Happy DOM Browser Settings as environment options to Jest.

{
  "testEnvironment": "@happy-dom/jest-environment",
  "testEnvironmentOptions": {
    "url": "http://localhost",
    "width": 1920,
    "height": 1080,
    "settings": {
      "navigator": {
         "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/58.0.3029.110 Safari/537.36"
      }
    }
  }
}