useGraphQLIntrospection

useGraphQLIntrospection(options?): UseQueryResult<NoInfer<{ __schema: IntrospectionSchema; } | undefined>, Error>

Hook to fetch the GraphQL schema via introspection

Parameters

Parameter	Type	Description
options?	{ enabled?: boolean; requestOptions?: GraphQLRequestOptions; staleTime?: number; }	Query options
options.enabled?	boolean	-
options.requestOptions?	GraphQLRequestOptions	-
options.staleTime?	number	-

Returns

UseQueryResult<NoInfer<{ __schema: IntrospectionSchema; } | undefined>, Error>

React Query result with schema introspection data

Example

function SchemaExplorer() {
  const { data, isLoading } = useGraphQLIntrospection()

  if (isLoading) return <div>Loading schema...</div>

  return (
    <div>
      <p>Query type: {data?.__schema.queryType.name}</p>
      <p>Types: {data?.__schema.types.length}</p>
    </div>
  )
}