Skip to content

Document refetchQueries caveat for skip vs skipToken#13290

Merged
jerelmiller merged 9 commits into
mainfrom
copilot/apolloclient-refetchqueries-fix
Jun 30, 2026
Merged

Document refetchQueries caveat for skip vs skipToken#13290
jerelmiller merged 9 commits into
mainfrom
copilot/apolloclient-refetchqueries-fix

Add skipToken refetch caveat to migration guide

a31c5b3
Select commit
Loading
Failed to load commit list.
Apollo Librarian / AI Style Review succeeded Jun 25, 2026 in 15s

Style Review Completed

The pull request has 1 style issue.

Duration: 2180ms
PR URL: #13290
Review Log: View detailed log
Review Comments: The AI has posted 1 inline comment with suggestions

Summary of changes:

The pull request updates the documentation to improve clarity and tone. Key changes include reframing content to be more reader-centric by using active voice and 'you' phrasing. Under the language and voice guidelines, idiomatic expressions like 'in standby' were replaced with clearer technical descriptions, and more authoritative language was adopted to prescribe the use of skipToken. Additionally, verb tenses were adjusted to use the present tense for describing version behavior, ensuring alignment with the technical style guide.

⚠️ This review and suggested changes are AI-generated. Please use common sense when accepting these suggestions, as they may not always be accurate or appropriate for your specific context.

Annotations

Check notice on line 1000 in docs/source/migrating/apollo-client-4-migration.mdx

See this annotation in the file changed.

@apollo-librarian apollo-librarian / AI Style Review

docs/source/migrating/apollo-client-4-migration.mdx#L1000

**Framing**: Use reader-centric language ('Queries you create') and avoid passive voice ('Apollo introduced' instead of 'This behavior was introduced').

**Language**: Avoid the idiom 'in standby' to ensure clarity for non-native speakers, and use 'does not' for a more formal tone if desired, though the primary issue is the idiomatic expression.

**Verb Tense and Voice**: Use present tense instead of past tense for describing version behavior.

**Voice**: The original text is unopinionated. Use authoritative language to prescribe the use of skipToken for this specific scenario.

```suggestion
Although both `skip` and `skipToken` put a query in standby, `client.refetchQueries({ include: [QUERY] })` handles them differently before the first execution. Queries you create with `skip: true` can still be refetched because Apollo Client already has their options, including any variables. Queries you create with `skipToken` are excluded until after their first execution because Apollo Client doesn't know which variables to use yet. Apollo introduced this behavior in v4.0.11.
```