Skip to content

Commit

Permalink
Emphasise required return
Browse files Browse the repository at this point in the history
Emphasise that `.rejects` and `.resolves` still require the assertion to be returned, in response to jestjs#4997.
  • Loading branch information
Vinnl authored Dec 1, 2017
1 parent 08f8394 commit 08a7a85
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/ExpectAPI.md
Original file line number Diff line number Diff line change
Expand Up @@ -395,6 +395,8 @@ test('resolves to lemon', () => {
});
```

Note that, since you are still testing promises, the test is still asynchronous. Hence, you will need to [tell Jest to wait](TestingAsyncCode.md#promises) by returning the unwrapped assertion.

Alternatively, you can use `async/await` in combination with `.resolves`:

```js
Expand Down Expand Up @@ -422,6 +424,8 @@ test('rejects to octopus', () => {
});
```

Note that, since you are still testing promises, the test is still asynchronous. Hence, you will need to [tell Jest to wait](TestingAsyncCode.md#promises) by returning the unwrapped assertion.

Alternatively, you can use `async/await` in combination with `.rejects`.

```js
Expand Down

0 comments on commit 08a7a85

Please sign in to comment.