Configure jest-mongodb in a TypeScript Node Project: A Complete Tutorial (2026)

In this tutorial, we are going to configure @shelf/jest-mongodb in a TypeScript Node.js project. This setup is essential for integration testing, allowing you to create a temporary MongoDB environment that doesn't affect your production or development databases. This approach significantly speeds up test execution and ensures isolation between test cases.

Key Takeaways

• Learn how to set up @shelf/jest-mongodb for integration testing in TypeScript.
• Understand how to configure a temporary MongoDB database for tests.
• Improve test speed and isolation by using in-memory databases.
• Get practical insights on troubleshooting common configuration errors.

Configuring @shelf/jest-mongodb is crucial for developers looking to perform integration testing in a Node.js environment. By utilizing a temporary database, you avoid the pitfalls of slow test execution and potential data corruption in your main database. This guide will walk you through the entire setup process, ensuring you have a robust testing environment by 2026 standards.

Prerequisites

• Node.js installed (version 18.0.0 or higher)
• TypeScript set up in your project
• Basic understanding of Jest and MongoDB
• npm or yarn for package management

Step 1: Install Required Packages

Before we start, you need to install @shelf/jest-mongodb and other necessary packages. Run the following command in your terminal:

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

This command installs Jest, TypeScript support for Jest, and the Jest MongoDB preset.

Step 2: Configure Jest and MongoDB

Create a configuration file named jest.config.js in the root of your project:

module.exports = {
  preset: '@shelf/jest-mongodb',
  transform: {
    '^.+\\.(ts|tsx)$': 'ts-jest',
  },
  testEnvironment: 'node',
};

This configuration tells Jest to use the MongoDB preset and enables TypeScript transformation using ts-jest.

Step 3: Set Up MongoDB Configuration

Create a file named jest-mongodb-config.js in the root directory with the following content:

module.exports = {
  mongodbMemoryServerOptions: {
    instance: {
      dbName: 'jest',
    },
    binary: {
      version: '5.0.0', // Use the MongoDB version that suits your project
      skipMD5: true,
    },
    autoStart: false,
  },
};

This configuration sets up an in-memory MongoDB server with a database named jest. Adjust the MongoDB version to match your project's requirements.

Step 4: Write a Sample Test

To verify that everything is set up correctly, let's write a simple test. Create a file named sample.test.ts:

import {MongoClient} from 'mongodb';

let connection: MongoClient;
let db: any;

beforeAll(async () => {
  connection = await MongoClient.connect(global.__MONGO_URI__, {
    useNewUrlParser: true,
    useUnifiedTopology: true,
  });
  db = await connection.db(global.__MONGO_DB_NAME__);
});

afterAll(async () => {
  await connection.close();
});

test('should insert a doc into collection', async () => {
  const users = db.collection('users');

  const mockUser = {_id: 'some-user-id', name: 'John Doe'};
  await users.insertOne(mockUser);

  const insertedUser = await users.findOne({_id: 'some-user-id'});
  expect(insertedUser).toEqual(mockUser);
});

This test connects to the in-memory MongoDB, inserts a document, and verifies the insertion. The use of global.__MONGO_URI__ and global.__MONGO_DB_NAME__ allows the test to connect to the correct MongoDB instance.

Step 5: Run Your Tests

Execute your tests using the command:

npm test

If everything is configured correctly, the test should pass without issues. This confirms that your Jest MongoDB setup is functioning as expected.

Common Errors/Troubleshooting

Here are some common errors you might encounter:

• Jest failed to connect to MongoDB: Ensure the MongoDB version in your configuration matches an available version.
• Global variables are undefined: Check that the preset @shelf/jest-mongodb is correctly applied in your Jest configuration.
• TypeScript errors: Ensure that ts-jest is properly installed and configured in your jest.config.js.

With these steps, you should have a fully functional test environment using @shelf/jest-mongodb in a TypeScript Node.js application. This setup will help streamline your integration testing, providing a reliable and fast solution.

Frequently Asked Questions

Why use jest-mongodb for testing?

Using jest-mongodb allows you to create a temporary, isolated database environment, which speeds up test execution and avoids data corruption in your main database.

How does jest-mongodb improve test speed?

By using an in-memory MongoDB instance, jest-mongodb significantly reduces the latency associated with database operations, making tests run faster.

What are the prerequisites for setting up jest-mongodb?

You need Node.js, TypeScript, and basic understanding of Jest and MongoDB to get started with jest-mongodb.