Class GraphQLClient

constructor

• new GraphQLClient(url, requestConfig?): GraphQLClient

• Parameters

  • url: string
  • Optional requestConfig: RequestConfig

  Returns GraphQLClient

rawRequest

Readonly requestConfig

batchRequests

• batchRequests<T, V>(documents, requestHeaders?): Promise<T>

• Send GraphQL documents in batch to the server.

  Type Parameters

  • T extends BatchResult
  • V extends Variables = Variables

  Parameters

  • documents: BatchRequestDocument<V>[]
  • Optional requestHeaders: GraphQLClientRequestHeaders

  Returns Promise<T>
• batchRequests<T, V>(options): Promise<T>

• Type Parameters

  • T extends BatchResult
  • V extends Variables = Variables

  Parameters

  • options: BatchRequestsOptions<V>

  Returns Promise<T>

request

• request<T, V>(document, ...variablesAndRequestHeaders): Promise<T>

• Send a GraphQL document to the server.

  Type Parameters

  • T
  • V extends Variables = Variables

  Parameters

  • document: RequestDocument | TypedDocumentNode<T, V>
  • Rest ...variablesAndRequestHeaders: VariablesAndRequestHeadersArgs<V>

  Returns Promise<T>
• request<T, V>(options): Promise<T>

• Type Parameters

  • T
  • V extends Variables = Variables

  Parameters

  • options: RequestOptions<V, T>

  Returns Promise<T>

setEndpoint

• setEndpoint(value): GraphQLClient

• Change the client endpoint. All subsequent requests will send to this endpoint.

  Parameters

  • value: string

  Returns GraphQLClient

setHeader

• setHeader(key, value): GraphQLClient

• Attach a header to the client. All subsequent requests will have this header.

  Parameters

  • key: string
  • value: string

  Returns GraphQLClient

setHeaders

• setHeaders(headers): GraphQLClient

• Parameters

  • headers: GraphQLClientRequestHeaders

  Returns GraphQLClient