Jest Global Setup in TypeScript: A Comprehensive Guide

Jest is a popular JavaScript testing framework known for its simplicity and powerful features. When working with TypeScript projects, integrating Jest can be a bit more involved, especially when it comes to global setup. Global setup in Jest allows you to run code before all the test suites are executed. This can be useful for tasks such as initializing a database connection, setting up environment variables, or mocking external services. In this blog post, we will explore the fundamental concepts of Jest global setup in TypeScript, learn about usage methods, common practices, and best practices.

Table of Contents#

  1. Fundamental Concepts
  2. Usage Methods
  3. Common Practices
  4. Best Practices
  5. Conclusion
  6. References

Fundamental Concepts#

Jest Global Setup#

Jest global setup is a script that runs once before all the test suites in your project. It is defined in the Jest configuration file (jest.config.js or jest.config.ts). The global setup script can be used to perform any setup tasks that are required for all the tests in your project.

TypeScript Integration#

When using TypeScript with Jest, you need to ensure that your TypeScript code is properly transpiled to JavaScript before Jest can execute it. You can use tools like ts-jest to achieve this. ts-jest is a TypeScript preprocessor for Jest that allows you to write your tests in TypeScript and have them automatically transpiled to JavaScript during the test execution.

Usage Methods#

Step 1: Install Dependencies#

First, make sure you have Jest and ts-jest installed in your project. You can install them using npm or yarn:

npm install --save-dev jest ts-jest @types/jest

Step 2: Configure Jest#

Create a jest.config.ts file in the root of your project with the following configuration:

import type { Config } from '@jest/types';
 
const config: Config.InitialOptions = {
  preset: 'ts-jest',
  testEnvironment: 'node',
  globalSetup: './global-setup.ts',
};
 
export default config;

In this configuration, we are using the ts-jest preset, setting the test environment to node, and specifying the global setup script as ./global-setup.ts.

Step 3: Create the Global Setup Script#

Create a global-setup.ts file in the root of your project:

export default async () => {
  // Perform any global setup tasks here
  console.log('Global setup is running...');
  // For example, you can set up environment variables
  process.env.TEST_VARIABLE = 'test-value';
};

Step 4: Run Tests#

Now you can run your tests using the following command:

npx jest

When you run the tests, you will see the message "Global setup is running..." printed in the console, indicating that the global setup script has been executed.

Common Practices#

Database Setup#

If your application uses a database, you can use the global setup script to initialize the database connection and perform any necessary migrations or seeding.

import { PrismaClient } from '@prisma/client';
 
const prisma = new PrismaClient();
 
export default async () => {
  // Connect to the database
  await prisma.$connect();
  // Perform migrations or seeding
  // For example, you can run a SQL script to seed the database
  await prisma.$executeRaw`INSERT INTO users (name) VALUES ('Test User')`;
};

Mocking External Services#

You can use the global setup script to mock external services such as APIs or third-party libraries.

import axios from 'axios';
 
jest.mock('axios');
 
export default async () => {
  // Mock an API response
  const mockedAxios = axios as jest.Mocked<typeof axios>;
  mockedAxios.get.mockResolvedValue({ data: { message: 'Mocked response' } });
};

Best Practices#

Error Handling#

Make sure to handle errors properly in the global setup script. If an error occurs during the global setup, Jest will stop executing the tests.

export default async () => {
  try {
    // Perform setup tasks
    await someAsyncTask();
  } catch (error) {
    console.error('Global setup failed:', error);
    throw error;
  }
};

Cleanup#

If you perform any setup tasks that require cleanup, such as creating temporary files or database connections, make sure to clean them up in the global teardown script. You can define a global teardown script in the Jest configuration file using the globalTeardown option.

import { PrismaClient } from '@prisma/client';
 
const prisma = new PrismaClient();
 
export default async () => {
  await prisma.$disconnect();
};

Conclusion#

Jest global setup in TypeScript is a powerful feature that allows you to perform setup tasks before all the test suites in your project. By following the concepts, usage methods, common practices, and best practices outlined in this blog post, you can effectively use Jest global setup to improve the reliability and maintainability of your tests. Whether it's setting up a database, mocking external services, or handling errors, the global setup script provides a centralized place to manage all the necessary setup tasks for your tests.

References#

2025-10