Options
All
  • Public
  • Public/Protected
  • All
Menu

Module api/client

To set up a GQL provider for your React app:

import { Provider } from 'api/client';

const App = () => (
    <Provider config={{url: 'https://your.graphql.url'}}>
        <App />
    </Provider>
);

Index

Functions

References

Interfaces

Type Aliases

Functions

getQueryNames

  • getQueryNames(doc: DocumentNode): string[]

  • Function to extract the query names from a GQL document

    Parameters

    • doc: DocumentNode

      DocumentNode from parsed GQL query

    Returns string[]

    An array of operation names

createGQLClient

Provider

  • Provider(options: { children: ReactNode; client?: Client; reset?: any }): ReactElement<any, string | JSXElementConstructor<any>>

  • A React Provider to configure an app-level graphql client...

    Parameters

    • options: { children: ReactNode; client?: Client; reset?: any }

    Returns ReactElement<any, string | JSXElementConstructor<any>>

useClient

useQuery

usePagingQuery

References

Client

Re-exports Client

Type Aliases

QueryResult

QueryResult<Data, Variables>: LoadingQueryResult<Data, Variables> | ErrorQueryResult<Data, Variables> | PausedQueryResult<Data, Variables> | EmptyQueryResult<Data, Variables> | SuccessQueryResult<Data, Variables>

Type Parameters

  • Data

  • Variables = undefined

Generated using TypeDoc