Using expect.assertions(x) vs using fail() in jest tests

user_10926293 0
Viewed 3004

I am setting up some asynchronous junit typescript tests and it seems I don't understand the documentation correctly.

I wrote a test asking a web API for a specific svg image by sending the ID of the image.

The test sends no ID so the web API should return http code 404. This the test and it works well:

test("getSvgByImageId unknown", () => {
    expect.assertions(1);

    return client.getSvgImageById("")
    .then(svg => {
        fail("API should return error")
    })
    .catch(error => {
        expect(error.status).toBe(404);
    })
});

But why should I use the expect.assertions(x) when I use the fail() method? The test also works without the expect.assertions(x) line.

jestjs typescript node.js javascript
1 Answers

From this post by a Jest collaborator in reference to the global fail() function:

That will stop working at some point - it's not part of Jest's documented API.

Jest is based on Jasmine and fail() is a carryover from Jasmine.

It is not officially part of the Jest documentation so it should not be used as it could be removed from future Jest releases.

user_101495100
Related