#require-to-throw-message

#Configuration

import { defineConfig, jestPlugin } from '@rslint/core';

export default defineConfig([
  jestPlugin.configs.recommended,
  {
    rules: {
      'jest/require-to-throw-message': 'error',
    },
  },
]);

#Rule Details

Require a message for toThrow() (and its alias toThrowError()).

toThrow() checks that a function throws, as in expect(() => a()).toThrow(). Without a message, the assertion passes for any thrown error. Requiring a message ensures the intended error is thrown.

This rule reports when toThrow() or toThrowError() is used with no argument. Negated forms such as .not.toThrow() without a message are allowed.

Examples of incorrect code for this rule:

test('all the things', async () => {
  expect(() => a()).toThrow();

  expect(() => a()).toThrowError();

  await expect(a()).rejects.toThrow();

  await expect(a()).rejects.toThrowError();
});

Examples of correct code for this rule:

test('all the things', async () => {
  expect(() => a()).toThrow('a');

  expect(() => a()).toThrowError('a');

  await expect(a()).rejects.toThrow('a');

  await expect(a()).rejects.toThrowError('a');

  expect(() => a()).not.toThrow();
});

#Original Documentation

• eslint-plugin-jest: require-to-throw-message
• Source code