jest-runtime 29.7.0

Jest-Runtime is a core package of the Jest testing platform. It is responsible for the essential functionality of evaluating and running your test code within a controlled environment. It works by compiling and executing your test files and their dependencies in isolation for each test suite, thereby ensuring accurate and uncorrupted test results.

To use jest-runtime, you'll first need to install it as a part of Jest npm package using either npm or yarn:

npm install --save jest

or

yarn add jest

Having installed Jest, jest-runtime is available for you to use. However, direct usage of jest-runtime is generally reserved for advanced use-cases.

Here's a simple Node.js script example that demonstrates how to use jest-runtime:

const Runtime = require('jest-runtime');
const path = require('path');

async function run() {
  const config = Runtime.createHasteMap.getDefaultConfig({
    rootDir: process.cwd(),
  });
  const hasteMap = await Runtime.createHasteMap(config);
  const resolver = Runtime.createResolver(
    config,
    hasteMap.moduleMap,
  );
  const runtime = new Runtime(config, resolver);

  runtime.requireModule(runtime.__mockRootPath, './test-to-run.js');
}

run();

In this script, we load a test script located at ./test-to-run.js using jest-runtime.

The documentation for jest-runtime can be found as part of Jest's official documentation on their website here. While the package's documentation may not be as rich or detailed as that of the main Jest library, the overall Jest documentation will provide further insights into its usage and capabilities.