jest-environment-node

What is jest-environment-node?

The jest-environment-node npm package is a test environment for Jest that simulates a Node.js environment. It is used when testing Node.js specific code. It provides a global environment that's set up for each test file to be executed in a Node-like environment, with all the necessary globals like `process` and `Buffer` available.

What are jest-environment-node's main functionalities?

Simulating Node.js Environment

This configuration in Jest's setup file tells Jest to use the Node environment for testing. It is useful when you want to test code that relies on Node.js APIs.

module.exports = { testEnvironment: 'jest-environment-node' };

Global Setup and Teardown

This feature allows you to extend the Node environment to add custom setup and teardown logic that runs before and after each test suite.

class CustomEnvironment extends NodeEnvironment {
  async setup() {
    await super.setup();
    // Your setup code here
  }

  async teardown() {
    // Your teardown code here
    await super.teardown();
  }
}

Custom Module Mocking

In a Node environment, you can mock Node modules like 'fs' to control their behavior during tests, which is useful for testing code that interacts with the filesystem without actually reading or writing files.

jest.mock('fs', () => ({
  readFileSync: jest.fn().mockReturnValue('mocked content'),
}));

Other packages similar to jest-environment-node

jest-environment-jsdom

This package is similar to jest-environment-node but is intended for testing web applications by simulating a browser environment using jsdom. It provides a DOM API that can be used in tests.

jest-environment-puppeteer

This package integrates Jest with Puppeteer for end-to-end testing. It sets up a browser environment and allows for testing user interactions with a real browser.

jest-environment-webdriver

This package is designed for integration with Selenium WebDriver for browser-based testing. It is similar to jest-environment-puppeteer but uses WebDriver API for controlling browsers.

README

The README file is missing

Changelog

26.0.0

Features

• [jest-environment-jsdom] [BREAKING] Upgrade jsdom to v16 (#9606)
• [@jest/fake-timers] Add possibility to use a modern implementation of fake timers, backed by @sinonjs/fake-timers (#7776)
• [jest-runtime] Add createMockFromModule as an alias for genMockFromModule (#9962)

Fixes

• [babel-jest] Handle null being passed to createTransformer (#9955)
• [jest-circus, jest-console, jest-jasmine2, jest-reporters, jest-util, pretty-format] Fix time durating formatting and consolidate time formatting code (#9765)
• [jest-circus] [BREAKING] Fail tests if a test takes a done callback and have return values (#9129)
• [jest-circus] [BREAKING] Throw a proper error if a test / hook is defined asynchronously (#8096)
• [jest-circus] Throw more descriptive error if hook is defined inside test (#9957)
• [jest-circus] [BREAKING] Align execution order of tests to match jasmine's top to bottom order (#9965)
• [jest-config, jest-resolve] [BREAKING] Remove support for browser field (#9943)
• [jest-haste-map] Stop reporting files as changed when they are only accessed (#7347)
• [jest-resolve] Show relative path from root dir for module not found errors (#9963)
• [jest-runtime] Fix absolute path moduleNameMapper + jest.mock bug (#8727)

Chore & Maintenance

• [*] [BREAKING] TypeScript definitions requires a minimum of TypeScript v3.8 (#9823)
• [*] [BREAKING] Drop support for Node 8 (#9423)
• [*] Upgrade to chalk@4 (#9752)
• [*] Remove usage of realpath-native (#9952)
• [docs] Fix example reference implementation to use Jest with Phabricator (#8662)
• [docs] Added default compiler to transform (#8583)
• [docs] Updated Testing Frameworks guide with React; make it generic (#9106)
• [expect, jest-mock, pretty-format] [BREAKING] Remove build-es5 from package (#9945)
• [@jest/fake-timers, @jest/environment] [BREAKING] Rename LolexFakeTimers to ModernFakeTimers (#9960)
• [jest-haste-map] [BREAKING] removed providesModuleNodeModules (#8535)
• [jest-runtime] [BREAKING] Remove long-deprecated require.requireActual and require.requireMock methods (#9854)