Skip to content

Commit

Permalink
fix: add to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jsjoeio committed Feb 15, 2022
1 parent 8cc0b32 commit 0f17e3d
Show file tree
Hide file tree
Showing 7 changed files with 14 additions and 0 deletions.
2 changes: 2 additions & 0 deletions website/versioned_docs/version-25.x/TestingAsyncCode.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,8 @@ If `done()` is never called, the test will fail (with timeout error), which is w

If the `expect` statement fails, it throws an error and `done()` is not called. If we want to see in the test log why it failed, we have to wrap `expect` in a `try` block and pass the error in the `catch` block to `done`. Otherwise, we end up with an opaque timeout error that doesn't show what value was received by `expect(data)`.

*Note: `done()` should not be mixed with Promises as this tends to lead to memory leaks in your tests.*

## Promises

If your code uses promises, there is a more straightforward way to handle asynchronous tests. Return a promise from your test, and Jest will wait for that promise to resolve. If the promise is rejected, the test will automatically fail.
Expand Down
2 changes: 2 additions & 0 deletions website/versioned_docs/version-26.x/TestingAsyncCode.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,8 @@ If `done()` is never called, the test will fail (with timeout error), which is w

If the `expect` statement fails, it throws an error and `done()` is not called. If we want to see in the test log why it failed, we have to wrap `expect` in a `try` block and pass the error in the `catch` block to `done`. Otherwise, we end up with an opaque timeout error that doesn't show what value was received by `expect(data)`.

*Note: `done()` should not be mixed with Promises as this tends to lead to memory leaks in your tests.*

## Promises

If your code uses promises, there is a more straightforward way to handle asynchronous tests. Return a promise from your test, and Jest will wait for that promise to resolve. If the promise is rejected, the test will automatically fail.
Expand Down
2 changes: 2 additions & 0 deletions website/versioned_docs/version-27.0/TestingAsyncCode.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,8 @@ If `done()` is never called, the test will fail (with timeout error), which is w

If the `expect` statement fails, it throws an error and `done()` is not called. If we want to see in the test log why it failed, we have to wrap `expect` in a `try` block and pass the error in the `catch` block to `done`. Otherwise, we end up with an opaque timeout error that doesn't show what value was received by `expect(data)`.

*Note: `done()` should not be mixed with Promises as this tends to lead to memory leaks in your tests.*

## Promises

If your code uses promises, there is a more straightforward way to handle asynchronous tests. Return a promise from your test, and Jest will wait for that promise to resolve. If the promise is rejected, the test will automatically fail.
Expand Down
2 changes: 2 additions & 0 deletions website/versioned_docs/version-27.1/TestingAsyncCode.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,8 @@ If `done()` is never called, the test will fail (with timeout error), which is w

If the `expect` statement fails, it throws an error and `done()` is not called. If we want to see in the test log why it failed, we have to wrap `expect` in a `try` block and pass the error in the `catch` block to `done`. Otherwise, we end up with an opaque timeout error that doesn't show what value was received by `expect(data)`.

*Note: `done()` should not be mixed with Promises as this tends to lead to memory leaks in your tests.*

## Promises

If your code uses promises, there is a more straightforward way to handle asynchronous tests. Return a promise from your test, and Jest will wait for that promise to resolve. If the promise is rejected, the test will automatically fail.
Expand Down
2 changes: 2 additions & 0 deletions website/versioned_docs/version-27.2/TestingAsyncCode.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,8 @@ If `done()` is never called, the test will fail (with timeout error), which is w

If the `expect` statement fails, it throws an error and `done()` is not called. If we want to see in the test log why it failed, we have to wrap `expect` in a `try` block and pass the error in the `catch` block to `done`. Otherwise, we end up with an opaque timeout error that doesn't show what value was received by `expect(data)`.

*Note: `done()` should not be mixed with Promises as this tends to lead to memory leaks in your tests.*

## Promises

If your code uses promises, there is a more straightforward way to handle asynchronous tests. Return a promise from your test, and Jest will wait for that promise to resolve. If the promise is rejected, the test will automatically fail.
Expand Down
2 changes: 2 additions & 0 deletions website/versioned_docs/version-27.4/TestingAsyncCode.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,8 @@ If `done()` is never called, the test will fail (with timeout error), which is w

If the `expect` statement fails, it throws an error and `done()` is not called. If we want to see in the test log why it failed, we have to wrap `expect` in a `try` block and pass the error in the `catch` block to `done`. Otherwise, we end up with an opaque timeout error that doesn't show what value was received by `expect(data)`.

*Note: `done()` should not be mixed with Promises as this tends to lead to memory leaks in your tests.*

## Promises

If your code uses promises, there is a more straightforward way to handle asynchronous tests. Return a promise from your test, and Jest will wait for that promise to resolve. If the promise is rejected, the test will automatically fail.
Expand Down
2 changes: 2 additions & 0 deletions website/versioned_docs/version-27.5/TestingAsyncCode.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,8 @@ If `done()` is never called, the test will fail (with timeout error), which is w

If the `expect` statement fails, it throws an error and `done()` is not called. If we want to see in the test log why it failed, we have to wrap `expect` in a `try` block and pass the error in the `catch` block to `done`. Otherwise, we end up with an opaque timeout error that doesn't show what value was received by `expect(data)`.

*Note: `done()` should not be mixed with Promises as this tends to lead to memory leaks in your tests.*

## Promises

If your code uses promises, there is a more straightforward way to handle asynchronous tests. Return a promise from your test, and Jest will wait for that promise to resolve. If the promise is rejected, the test will automatically fail.
Expand Down

0 comments on commit 0f17e3d

Please sign in to comment.