docs: add a waitBeforeRetry (#14737)

jestjs · Dec 4, 2023 · 4db36ca · 4db36ca
1 parent 9825019
commit 4db36ca
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 1 deletion.
diff --git a/docs/JestObjectAPI.md b/docs/JestObjectAPI.md
@@ -1071,6 +1071,16 @@ test('will fail', () => {
 });
 ```
 
+`waitBeforeRetry` is the number of milliseconds to wait before retrying.
+
+```js
+jest.retryTimes(3, {waitBeforeRetry: 1000});
+
+test('will fail', () => {
+  expect(true).toBe(false);
+});
+```
+
 Returns the `jest` object for chaining.
 
 :::caution

diff --git a/packages/jest-environment/src/index.ts b/packages/jest-environment/src/index.ts
@@ -305,7 +305,7 @@ export interface Jest {
    */
   retryTimes(
     numRetries: number,
-    options?: {logErrorsBeforeRetry?: boolean; waitBeforeRetry: number},
+    options?: {logErrorsBeforeRetry?: boolean; waitBeforeRetry?: number},
   ): Jest;
   /**
    * Exhausts tasks queued by `setImmediate()`.