Skip to content

Document fetchPolicy option for fetchQuery #5244

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

Closed
skrabe wants to merge 1 commit into from
+5 −0
Closed

Document fetchPolicy option for fetchQuery #5244

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
5 changes: 5 additions & 0 deletions website/docs/api-reference/relay-runtime/fetch-query.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,11 @@ fetchQuery(
* `options`: *_[Optional]_* options object
* `networkCacheConfig`: *_[Optional]_ *Object containing cache config options
* `force`: Boolean value. If true, will bypass the network response cache. Defaults to true.
* `fetchPolicy`: *_[Optional]_* Determines whether `fetchQuery` should reuse data that is already available in the local Relay store. Must be one of the following values:
* `"network-only"`: *(default)* Always issue a network request, regardless of what is in the store.
* `"store-or-network"`: Reuse data from the store if the full query is available locally; otherwise, issue a network request.

The `"store-and-network"` and `"store-only"` fetch policies are **not supported** by `fetchQuery`, because it is designed around issuing a single network request and returning the response. If you need those policies, use [`useLazyLoadQuery`](../use-lazy-load-query/) instead.

### Flow Type Parameters

Expand Down