GraphQL.Client.Http

The functions in this module let you perform HTTP requests to conventional GraphQL server endpoints.

type Error

= HttpError Error

| GraphQLError (List RequestError)

Represents errors that can occur when sending a GraphQL request over HTTP.

type alias RequestError =

{ message : String

, locations : List DocumentLocation

}

An error returned by the GraphQL server that indicates there was something wrong with the request.

type alias DocumentLocation =

{ line : Int

, column : Int

}

A location in a GraphQL request document.

sendQuery : String -> Request Query result -> Task Error result

Takes a URL and a Query Request and returns a Task that you can perform with Task.attempt which will send a POST request to a GraphQL server at the given endpoint.

sendMutation : String -> Request Mutation result -> Task Error result

Takes a URL and a Mutation Request and returns a Task that you can perform with Task.attempt which will send a POST request to a GraphQL server at the given endpoint.

type alias RequestOptions =

{ method : String

, headers : List Header

, url : String

, timeout : Maybe Time

, withCredentials : Bool

}

Options available for customizing GraphQL HTTP requests. method should be either "GET" or "POST". For GET requests, the url is modified to include extra parameters in the query string for the GraphQL document and variables. Otherwise, the document and variables are included in the HTTP request body.

customSendQuery : RequestOptions -> Request Query result -> Task Error result

Like sendQuery, but takes an RequestOptions value instead of a URL to let you further customize the HTTP request.

customSendMutation : RequestOptions -> Request Mutation result -> Task Error result

Like sendMutation, but takes an RequestOptions value instead of a URL to let you further customize the HTTP request.

jamesmacaulay/elm-graphql/1.3.2

GraphQL.Client.Http

Modules