How to use Jest for testing TypeScript code

Testing is an essential part of software development, ensuring the reliability and correctness of our code. When it comes to testing TypeScript projects, Jest has emerged as a popular and powerful testing framework.

Setting up Jest

Setting up Jest in a TypeScript project is a straightforward process that allows us to harness the power of this testing framework for our TypeScript codebase. To begin, we need to install Jest and its related dependencies using npm, the Node package manager. We can run the following command in the terminal to install Jest:

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

This command installs Jest as a dev dependency in our project and also installs the necessary type definitions for TypeScript. Once Jest is installed, we can configure it to work seamlessly with TypeScript by creating a jest.config.js file and specifying the required TypeScript compiler options.

Writing a test in TypeScript with Jest

Writing tests with Jest in TypeScript is a straightforward process that allows us to verify the behavior of our code. Let’s take a look at a simple example:

hello_jest.spec.ts
tsconfig.json
export function greet(name: string): string {
  return `Hello, ${name}!`;
}
test('greet function should return the correct greeting', () => {
  const name = 'John';
  const greeting = greet(name);
  expect(greeting).toBe('Hello, John!');
});

Explanation

  • Lines 1–3: The export function greet(name: string): string defines a function named greet that takes a parameter name of type string and returns a string. Inside the function, a template literal is used to construct a greeting message that includes the name parameter. The return statement returns this greeting message as a string.

  • Line 5: The test function from Jest is used to define a test case. It takes two parameters: a string describing the test case and an arrow function containing the test logic.

  • Lines 6–7: Inside the test case function, we define a constant variable name and assign the string value 'John' to it. This will serve as the input argument for the greet function. The const greeting = greet(name); invokes the greet function with the name argument and assigns the returned value to the constant variable greeting.

  • Line 8: The expect function is used to make assertions in Jest. It takes a value that we want to test. The .toBe() matcher is used to compare the greeting value with the expected value 'Hello, John!'. If the values match, the test passes; otherwise, it fails.

By running this test, we verify that the greet function correctly returns the greeting message "Hello, John!" when called with the name "John". However, when we change this to any other name, the test will fail.

Note: This answer focuses on a specific type of test using Jest to demonstrate the process of testing TypeScript code. It’s important to recognize that Jest offers a wide array of testing capabilities beyond what is covered here.

widget

Best practices for testing TypeScript with Jest

When writing tests for TypeScript code with Jest, it’s important to follow some best practices to ensure effective and maintainable tests:

  1. Type safety: Leverage TypeScript’s static typing system to provide type safety in your test code. Use type annotations for function arguments and return values to catch type-related errors during development.

  2. Descriptive test names: Give descriptive names to your test cases, clearly indicating what is being tested. This helps in understanding the purpose of the test and facilitates debugging.

  3. Clear assertions: Write clear and concise assertions using Jest’s assertion methods. Use matchers like .toBe() and .toEqual() to make precise assertions about values.

Free Resources

Copyright ©2025 Educative, Inc. All rights reserved