Class GraphQLClient

GraphQL Client.

Hierarchy

  • GraphQLClient

Constructors

constructor

Properties

rawRequest requestConfig url

Methods

batchRequests request setEndpoint setHeader setHeaders

Constructors

constructor

  • Parameters

    • url: string
    • Optional requestConfig: RequestConfig

    Returns GraphQLClient

Properties

rawRequest

rawRequest: RawRequestMethod

Send a GraphQL query to the server.

Readonly requestConfig

requestConfig: RequestConfig

Private url

url: any

Methods

batchRequests

  • Send GraphQL documents in batch to the server.

    Type Parameters

    • T extends [Result<object>, ...Result<object>[]]

    • V extends Variables = Variables

    Parameters

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

    Returns Promise<T>

  • Type Parameters

    • T extends [Result<object>, ...Result<object>[]]

    • V extends Variables = Variables

    Parameters

    • options: BatchRequestsOptions<V>

    Returns Promise<T>

request

  • 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>

  • Type Parameters

    • T

    • V extends Variables = Variables

    Parameters

    • options: RequestOptions<V, T>

    Returns Promise<T>

setEndpoint

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

    Parameters

    • value: string

    Returns GraphQLClient

setHeader

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

    Parameters

    • key: string
    • value: string

    Returns GraphQLClient

setHeaders

  • Parameters

    • headers: GraphQLClientRequestHeaders

    Returns GraphQLClient

Settings

Member Visibility

Theme

Generated using TypeDoc