PackagesReroutesAboutlamdera.com

ryannhg/graphql/2.0.0

NOTE: the latest version is 2.1.0

Renamed to ryan-haskell/graphql. It is published under that name, and new versions come out there.

Versions published as ryannhg/graphql still install under that name. 4 versions of 4 come from the new location (see their notes).

Rerouted (renamed, verified). The GitHub user or repository was renamed. The tag is still there, at the new name. The Lamdera package server serves a copy recovered from https://github.com/ryan-haskell/graphql.

What we checked: The repo moved to github.com/ryan-haskell/graphql. Rebuilt with git archive from commit c7b87f74a1c6 of https://github.com/ryan-haskell/graphql (zip prefix ryannhg-graphql-32f4d56/, America/Los_Angeles times): the zip is byte-identical to the one package.elm-lang.org recorded, SHA-1 bf8f7cf9d464c043c51937e29fdee00d18573cc2.

The Lamdera compiler uses this copy and prints a one-line notice saying so. elm itself fails to download this version.

Details · package.elm-lang.org's zip: https://github.com/ryannhg/graphql/zipball/2.0.0/

READMEAboutVersionsSourceModules

GraphQL.Http

HTTP requests

get :
{ url : String
, query : String
, variables : List ( String, Value )
, decoder : Decoder data
, onResponse : Result Error data -> msg
}
-> Cmd msg

Send an HTTP GET request to your GraphQL API

GraphQL.Http.get
    { url = "/api/graphql"
    , query = """
        query FindPerson(name: $name) {
            person(name: $name) {
                id
                name
            }
        }
    """
    , variables =
        [ ( "name", GraphQL.Encode.string "Doug" )
        ]
    , onResponse = ApiResponded
    , decoder = decoder
    }
{ url : String
, query : String
, variables : List ( String, Value )
, decoder : Decoder data
, onResponse : Result Error data -> msg
}
-> Cmd msg

Send an HTTP POST request to your GraphQL API

GraphQL.Http.post
    { url = "/api/graphql"
    , query = """
        query FindPerson(name: $name) {
            person(name: $name) {
                id
                name
            }
        }
    """
    , variables =
        [ ( "name", GraphQL.Encode.string "Doug" )
        ]
    , onResponse = ApiResponded
    , decoder = decoder
    }

Errors

type Error
= BadUrl String
| Timeout
| NetworkError
| GraphQL { errors : List Error }
| UnexpectedResponse
{ url : String
, statusCode : Int
, statusText : String
, headers : Dict String String
, body : String
, jsonError : Maybe Error
}

When something goes wrong with the GraphQL request, this error type will be returned with your Result.

This extends the default Http.Error to include more context and GraphQL specific errors returned from the API.

Advanced usage with elm/http

The two functions below are helpful for more advanced applications using functions like Http.request.

Use these if you need to send HTTP headers, define request timeouts, etc.

import GraphQL.Http
import Http


fetchCurrentUser : Cmd Msg
fetchCurrentUser =
    Http.request
        { method = "POST"
        , url = "/api/graphql"
        , headers = []
        , body =
            GraphQL.Http.body
                { operationName = Just "FetchCurrentUser"
                , query = """
                    query FetchCurrentUser {
                        me {
                            id
                            name
                        }
                    }
                """
                , variables = []
                }
        , expect =
            GraphQL.Http.expect
                FetchCurrentUserApiResponded
                decoder
        , tracker = Nothing
        , timeout = Nothing
        }
{ operationName : Maybe String
, query : String
, variables : List ( String, Value )
}
-> Body

Create the JSON body for your GraphQL request.

GraphQL.Http.body
    { operationName = Just "FetchCurrentUser"
    , query = """
        query FetchCurrentUser {
            me {
                id
                name
            }
        }
    """
    , variables = []
    }
expect : (Result Error data -> msg) -> Decoder data -> Expect msg

Expect a JSON response from a GraphQL API.

type Msg
    = ApiResponded (Result GraphQL.Http.Error Data)


fetchData : Cmd Msg
fetchData =
    Http.request
        { -- ... other fields
        , expect =
            GraphQL.Http.expect
                ApiResponded
                decoder
        }

Partial errors

( Result
{ data : data
, errors : List Error
}
-> msg
)
-> Decoder data
-> Expect msg

According to the GraphQL specification, it's possible to receive GraphQL errors alongside a valid data response:

{
  "errors": [
    {
      "message": "Name for character with ID 1002 could not be fetched.",
      "locations": [ { "line": 6, "column": 7 } ],
      "path": [ "hero", "heroFriends", 1, "name" ]
    }
  ],
  "data": {
    "hero": {
      "name": "R2-D2",
      "heroFriends": [
        {
          "id": "1000",
          "name": "Luke Skywalker"
        },
        null,
        {
          "id": "1003",
          "name": "Leia Organa"
        }
      ]
    }
  }
}

If your application needs to access those partial error responses, use this rather than the simpler expect function:

type Msg
    = ApiResponded
        (Result GraphQL.Http.Error
            { data : Data
            , errors : List GraphQL.Error.Error
            }
        )


fetchData : Cmd Msg
fetchData =
    Http.request
        { -- ... other fields
        , expect =
            GraphQL.Http.expectWithPartialErrors
                ApiResponded
                decoder
        }

Modules

About this package serverReroutesreroutes.json
Pages and docs rendering from package.elm-lang.org, © 2012-2020 Evan Czaplicki. © 2026 Lamdera