Skip to content

fix(docs): fix testing example #1698

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

Merged
boschni merged 1 commit into from
Feb 11, 2021
Merged

fix(docs): fix testing example #1698

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 5 additions & 4 deletions docs/src/pages/guides/testing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,7 @@ Once installed, a simple test can be written. Given the following custom hook:

```
export function useCustomHook() {
const { data } = useQuery('customHook', () => 'Hello');
return data;
return useQuery('customHook', () => 'Hello');
}
```

Expand All @@ -36,9 +35,11 @@ const wrapper = ({ children }) => (
</QueryClientProvider>
);

const { result } = renderHook(() => useCustomHook(), { wrapper });
const { result, waitFor } = renderHook(() => useCustomHook(), { wrapper });

expect(result.current).toEqual('Hello');
await waitFor(() => result.current.isSuccess);

expect(result.current.data).toEqual("Hello");
```

Note that we provide a custom wrapper that builds the `QueryClient` and `QueryClientProvider`. This helps to ensure that our test is completely isolated from any other tests.
Expand Down