docs(cancel): add graphql-request example

[arnaudbzn]

It is possible to set an AbortSignal in the GraphQLClient constructor.

const query = useQuery('todos', ({ signal }) => {
  const client = new GraphQLClient(endpoint, {
    signal,
  });
  return client.request(query, variables)
})

But unfortunately, it is not possible to define a signal per request:
graffle-js/graffle#182

It means that the GraphQL Code Gen React Query plugin cannot support a signal for the moment with graphql-request 😔

The solution is to:

• PR graphql-request to support a signal per request
• PR GraphQL Code Gen React Query Plugin to send the signal to the graphql-request request.

[vercel]

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/tanstack/react-query/B5Jar7gZ5ncF4xtaYntyXaioa2Um
✅ Preview: https://react-query-git-fork-arnaudbzn-docs-query-cance-5d3533-tanstack.vercel.app

[codecov]

Codecov Report

Merging #2948 (26a8cb8) into master (c1ae82b) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #2948   +/-   ##
=======================================
  Coverage   96.40%   96.40%           
=======================================
  Files          45       45           
  Lines        2227     2227           
  Branches      637      637           
=======================================
  Hits         2147     2147           
  Misses         77       77           
  Partials        3        3           

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c1ae82b...26a8cb8. Read the comment docs.

[TkDodo]

thank you. do you know if there are other graphql fetching libs that would support it right now? Like maybe @urql/core?

[arnaudbzn]

New graphq-request PR to support a signal argument in the request function:
graffle-js/graffle#303

[arnaudbzn]

thank you. do you know if there are other graphql fetching libs that would support it right now? Like maybe @urql/core?

I have not found in the urql docs and code how to set a signal.
I may not use urql as a graphql fetcher for React Query, graphql-request is super lean and does the job.
I'm not aware of other basic graphql fetchers.

[TkDodo]

oh wow, you already PR'ed to graphql-request 🚀

should we wait with this docs until it lands, or should we merge this doc PR right away?

[arnaudbzn]

oh wow, you already PR'ed to graphql-request 🚀

should we wait with this docs until it lands, or should we merge this doc PR right away?

😁
We can merge now because it is useful to know the current possibilities with graphql-request and I've no visibility on when the PR will be merged... 🐌

I'll update the doc when the graphql-request PR will be merged in another RQ PR.

[tannerlinsley]

🎉 This PR is included in version 3.33.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀