Skip to content
Add custom message to Jest expects πŸƒπŸ—―
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Bootstrap project with oss-box Aug 7, 2018
docs Bootstrap project with oss-box Aug 7, 2018
src Add support for custom matchers Oct 23, 2018
.all-contributorsrc
.eslintrc Add missing lint config Aug 7, 2018
.gitignore Bootstrap project with oss-box Aug 7, 2018
.travis.yml
CONTRIBUTING.md Bootstrap project with oss-box Aug 7, 2018
LICENSE Bootstrap project with oss-box Aug 7, 2018
README.md Update to include v24 config format Jan 28, 2019
package.json 1.0.2 Oct 23, 2018
yarn.lock

README.md

jest-expect-message

πŸƒπŸ—―

Add custom message to Jest expects


Build Status Code Coverage version downloads MIT License PRs Welcome Roadmap Examples

Problem

In many testing libraries it is possible to supply a custom message for a given expectation, this is currently not possible in Jest.

For example:

test('returns 2 when adding 1 and 1', () => {
  expect(1 + 1, 'Woah this should be 2!').toBe(3);
});

This will throw the following error in Jest:

Expect takes at most one argument.

Solution

jest-expect-message allows you to call expect with a second argument of a String message.

For example the same test as above:

test('returns 2 when adding 1 and 1', () => {
  expect(1 + 1, 'Woah this should be 2!').toBe(3);
});

With jest-expect-message this will fail with your custom error message:

  ● returns 2 when adding 1 and 1

    Custom message:
      Woah this should be 2!

    expect(received).toBe(expected) // Object.is equality

    Expected: 3
    Received: 2

Installation

With npm:

npm install --save-dev jest-expect-message

With yarn:

yarn add -D jest-expect-message

Setup

Add jest-expect-message to your Jest setupFilesAfterEnv configuration. See for help

Jest v24+

"jest": {
  "setupFilesAfterEnv": ["jest-expect-message"]
}

Jest v23-

"jest": {
  "setupTestFrameworkScriptFile": "jest-expect-message"
}

Usage

  • expect(actual, message)
    • actual: The value you would normally pass into an expect to assert against with a given matcher.
    • message: String, the custom message you want to be printed should the expect fail.
test('returns 2 when adding 1 and 1', () => {
  expect(1 + 1, 'Woah this should be 2!').toBe(3);
});

Contributors


Matt Phillips

πŸ’» πŸ“– πŸ’‘ πŸ€” πŸš‡ ⚠️ πŸ”§

LICENSE

MIT

You can’t perform that action at this time.