Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add sync-only info to expect.toThrowError TIP #7381

Merged
merged 3 commits into from
Feb 10, 2025
Merged

docs: Add sync-only info to expect.toThrowError TIP #7381

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f3c6b25
docs: Add sync-only note to expect.toThrowError
flx-sta Jan 29, 2025
3cb55e6
docs: Add not async note to expect.toThrowError TIP
flx-sta Feb 4, 2025
78c249c
docs: remove semicolons from code in TIP
flx-sta Feb 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/api/expect.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -701,6 +701,14 @@ You can provide an optional argument to test that a specific error is thrown:

:::tip
You must wrap the code in a function, otherwise the error will not be caught, and test will fail.

This does not apply for async calls as [rejects](#rejects) correctly unwraps the promise:
```ts
test('expect rejects toThrow', async ({ expect }) => {
const promise = Promise.reject(new Error('Test'))
await expect(promise).rejects.toThrowError()
})
```
:::

For example, if we want to test that `getFruitStock('pineapples')` throws, we could write:
Expand Down