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

Jump to bottom

docs: fix graphql-request react-query wrapper example #9890

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

docs: fix graphql-request react-query wrapper example #9890

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5de90aa
docs: fix `graphql-request` `react-query` wrapper example
llllvvuu Mar 2, 2024
a4db023
docs: update custom fetcher section as well
llllvvuu Mar 2, 2024
adeba93
docs: remove trailing space
llllvvuu Mar 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
101 changes: 77 additions & 24 deletions website/src/pages/docs/guides/react-vue.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -554,22 +554,69 @@ The use of `@tanstack/react-query` along with `graphql-request@^5` is highly rec
Create a file with the following helper function within your project:

```ts filename="useGraphQL helper function"
import request from 'graphql-request'
import { type TypedDocumentNode } from '@graphql-typed-document-node/core'
import { useQuery, type UseQueryResult } from '@tanstack/react-query'
import {
useMutation,
type UseMutationOptions,
useQuery,
type UseQueryOptions,
} from '@tanstack/react-query'
import type { DirectiveDefinitionNode } from 'graphql'
import { request, type RequestOptions } from 'graphql-request'

export const getKey = <TData = unknown, TVariables = unknown>(
document: TypedDocumentNode<TData, TVariables>,
) => [(document.definitions[0] as DirectiveDefinitionNode).name.value]

export const useGqlQuery = <
TData = unknown,
TVariables = unknown,
TError = unknown,
>(
document: TypedDocumentNode<TData, TVariables>,
variables?: TVariables,
options?: UseQueryOptions<TData, TError, TData>,
requestHeaders?: RequestOptions['requestHeaders'],
) => {
const url = 'https://swapi-graphql.netlify.app/.netlify/functions/index'
return useQuery<TData, TError, TData>({
...options,
queryKey: [url, ...getKey(document), variables, requestHeaders],
queryFn: () =>
request({
url,
document,
...(variables && { variables }),
...(requestHeaders && { requestHeaders }),
}),
})
}

export function useGraphQL<TResult, TVariables>(
document: TypedDocumentNode<TResult, TVariables>,
...[variables]: TVariables extends Record<string, never> ? [] : [TVariables]
): UseQueryResult<TResult> {
return useQuery([(document.definitions[0] as any).name.value, variables], async ({ queryKey }) =>
request(
'https://swapi-graphql.netlify.app/.netlify/functions/index',
document,
queryKey[1] ? queryKey[1] : undefined
)
)
export const useGqlMutation = <
TData = unknown,
TVariables = unknown,
TError = unknown,
TContext = unknown,
>(
document: TypedDocumentNode<TData, TVariables>,
variables?: TVariables,
options?: UseMutationOptions<TData, TError, TVariables, TContext>,
requestHeaders?: RequestOptions['requestHeaders'],
) => {
const url = 'https://swapi-graphql.netlify.app/.netlify/functions/index'
return useMutation<TData, TError, TVariables, TContext>({
...options,
mutationKey: [url, ...getKey(document), variables, requestHeaders],
mutationFn: () =>
request({
url,
document,
...(variables && { variables }),
...(requestHeaders && { requestHeaders }),
}),
})
}

```

Then write type-safe code like the following:
Expand All @@ -592,7 +639,7 @@ const allFilmsWithVariablesQueryDocument = graphql(/* GraphQL */ `

function App() {
// `data` is properly typed, inferred from `allFilmsWithVariablesQueryDocument` type
const { data } = useGraphQL(
const { data } = useGqlQuery(
allFilmsWithVariablesQueryDocument,
// variables are also properly type-checked.
{ first: 10 }
Expand Down Expand Up @@ -620,14 +667,19 @@ To implement your own React Query fetcher while preserving the GraphQL document

```ts filename="Custom fetcher function and useGraphQL hook implementation"
import { type TypedDocumentNode } from '@graphql-typed-document-node/core'
import { useQuery, type UseQueryResult } from '@tanstack/react-query'
import { print, type ExecutionResult } from 'graphql'
import { useQuery } from '@tanstack/react-query'
import type { DirectiveDefinitionNode } from 'graphql'
import { print } from 'graphql'

export const getKey = <TData = unknown, TVariables = unknown>(
document: TypedDocumentNode<TData, TVariables>,
) => [(document.definitions[0] as DirectiveDefinitionNode).name.value]

/** Your custom fetcher function */
async function customFetcher<TResult, TVariables>(
url: string,
document: TypedDocumentNode<TResult, TVariables>,
...[variables]: TVariables extends Record<string, never> ? [] : [TVariables]
variables?: TVariables | undefined,
): Promise<TResult> {
const response = await fetch(url, {
method: 'POST',
Expand All @@ -643,16 +695,17 @@ async function customFetcher<TResult, TVariables>(
throw new Error(`Failed to fetch: ${response.statusText}. Body: ${await response.text()}`)
}

return await response.json()
return await response.json() as TResult
}

export function useGraphQL<TResult, TVariables>(
export function useGraphQL<TResult = unknown, TVariables = unknown>(
document: TypedDocumentNode<TResult, TVariables>,
...[variables]: TVariables extends Record<string, never> ? [] : [TVariables]
): UseQueryResult<ExecutionResult<TResult>> {
return useQuery([(document.definitions[0] as any).name.value, variables], () =>
customFetcher('https://swapi-graphql.netlify.app/.netlify/functions/index', document, variables)
)
variables?: TVariables,
) {
return useQuery({
queryKey: [getKey(document), variables],
queryFn: () => customFetcher('https://swapi-graphql.netlify.app/.netlify/functions/index', document, variables),
})
}
```

Expand Down