From 0f17e3de93e8a11c9522aaaf8dc5e5709eb7bc58 Mon Sep 17 00:00:00 2001 From: Joe Previte Date: Tue, 15 Feb 2022 13:32:11 -0700 Subject: [PATCH] fix: add to docs --- website/versioned_docs/version-25.x/TestingAsyncCode.md | 2 ++ website/versioned_docs/version-26.x/TestingAsyncCode.md | 2 ++ website/versioned_docs/version-27.0/TestingAsyncCode.md | 2 ++ website/versioned_docs/version-27.1/TestingAsyncCode.md | 2 ++ website/versioned_docs/version-27.2/TestingAsyncCode.md | 2 ++ website/versioned_docs/version-27.4/TestingAsyncCode.md | 2 ++ website/versioned_docs/version-27.5/TestingAsyncCode.md | 2 ++ 7 files changed, 14 insertions(+) diff --git a/website/versioned_docs/version-25.x/TestingAsyncCode.md b/website/versioned_docs/version-25.x/TestingAsyncCode.md index 2352de9a38c3..7b598d04aac8 100644 --- a/website/versioned_docs/version-25.x/TestingAsyncCode.md +++ b/website/versioned_docs/version-25.x/TestingAsyncCode.md @@ -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. diff --git a/website/versioned_docs/version-26.x/TestingAsyncCode.md b/website/versioned_docs/version-26.x/TestingAsyncCode.md index 2352de9a38c3..7b598d04aac8 100644 --- a/website/versioned_docs/version-26.x/TestingAsyncCode.md +++ b/website/versioned_docs/version-26.x/TestingAsyncCode.md @@ -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. diff --git a/website/versioned_docs/version-27.0/TestingAsyncCode.md b/website/versioned_docs/version-27.0/TestingAsyncCode.md index 2352de9a38c3..7b598d04aac8 100644 --- a/website/versioned_docs/version-27.0/TestingAsyncCode.md +++ b/website/versioned_docs/version-27.0/TestingAsyncCode.md @@ -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. diff --git a/website/versioned_docs/version-27.1/TestingAsyncCode.md b/website/versioned_docs/version-27.1/TestingAsyncCode.md index 2352de9a38c3..7b598d04aac8 100644 --- a/website/versioned_docs/version-27.1/TestingAsyncCode.md +++ b/website/versioned_docs/version-27.1/TestingAsyncCode.md @@ -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. diff --git a/website/versioned_docs/version-27.2/TestingAsyncCode.md b/website/versioned_docs/version-27.2/TestingAsyncCode.md index 2352de9a38c3..7b598d04aac8 100644 --- a/website/versioned_docs/version-27.2/TestingAsyncCode.md +++ b/website/versioned_docs/version-27.2/TestingAsyncCode.md @@ -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. diff --git a/website/versioned_docs/version-27.4/TestingAsyncCode.md b/website/versioned_docs/version-27.4/TestingAsyncCode.md index 2352de9a38c3..7b598d04aac8 100644 --- a/website/versioned_docs/version-27.4/TestingAsyncCode.md +++ b/website/versioned_docs/version-27.4/TestingAsyncCode.md @@ -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. diff --git a/website/versioned_docs/version-27.5/TestingAsyncCode.md b/website/versioned_docs/version-27.5/TestingAsyncCode.md index 2352de9a38c3..7b598d04aac8 100644 --- a/website/versioned_docs/version-27.5/TestingAsyncCode.md +++ b/website/versioned_docs/version-27.5/TestingAsyncCode.md @@ -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.