it() done documentation?

[ryyppy]

Hi!

Today I was in a dire need of a fail() function to fail my tests and after looking through documentation and examples, I remembered there was this it('', (done) => {...}) thing, in a time where Promises were not yet popular :-)

I realized that done is not only a function, but also has a done.fail(), which is super valuable for cases like

try {
  await fnWhichShouldFail();
  done.fail();
} catch(e) {
  expect(e.message).toBe('some failure');
}

For async function flows or chained promises with a catch, I didn't find a clean way to prevent undetected errors for erroneous testing code (if I hadn't had the done.fail() in the example above, a test would run through green, if fnWhichShouldFail() was mocked wrongly and doesn't throw.

So my question is: Is there any reason why there is no documentation about that? Or do you have plans for a better API replacement?

[0xR]

Note jest uses jasmine and the jasmine docs say this: https://jasmine.github.io/2.5/introduction.html#section-58

[cpojer]

Yeah, for now we rely on the Jasmine docs for this. We'll document it at some point when we have something new. If you'd like to document the done syntax on the Jest website, please send us a PR :)

[github-actions]

This issue has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.
Please note this issue tracker is not a help forum. We recommend using StackOverflow or our discord channel for questions.