A specification for the type of a Variable which includes enough information to extract a conforming value from an Elm value.

This type is used as a marker for the VariableSpec type's nullability parameter to indicate that the described GraphQL variable may be filled with a null value.

This type is used as a marker for the VariableSpec type's nullability parameter to indicate that the described GraphQL variable will never be filled with a null value.

This type represents a GraphQL variable definition, and includes enough information to extract a conforming GraphQL value from some arbitrary source type supplied by your Elm code.

Describes a single field of a GraphQL Input Object type.

Construct a Variable that has no default value, and therefore must extract its value from a source. The first argument is the name of the variable that appears in the GraphQL request document, and must be unique for that document. It should not include any leading dollar sign ($). The second argument is a function that extracts a value of the required type from a source. The third argument is a VariableSpec that describes the type of the variable.

Construct a Variable that has a default value, and therefore its source may or may not provide a value for it. The first three arguments are the same as for the required function, except that the function to extract a value from source must return a Maybe of the type expected by the VariableSpec. The last argument is a default value for the variable.

Note that the VariableSpec may be either Nullable or NonNull, but in both cases the variable definition is serialized without a Non-Null modifier in the GraphQL request document, because optional variables may not be Non-Null in GraphQL. If you pass a NonNull VariableSpec into this function, it just means that you won't be able to represent an explicit null for the variable's value. If instead you pass a Nullable VariableSpec into this function, you will be able to represent an explicit null value for the variable, but you'll also have to deal with double-wrapped Maybe values – a missing value is then represented as a Nothing returned from your extraction function, and a null value is represented as Just Nothing. For this reason, it is recommended that you stick to NonNull VariableSpec values here unless you really need to be able to pass null explictly to the GraphQL server.

A VariableSpec for the GraphQL Int type that extracts its value from an Elm Int.

A VariableSpec for the GraphQL Float type that extracts its value from an Elm Float.

A VariableSpec for the GraphQL String type that extracts its value from an Elm String.

A VariableSpec for the GraphQL Boolean type that extracts its value from an Elm Bool.

A VariableSpec for the GraphQL ID type that extracts its value from an Elm String.

Constructs a VariableSpec for a GraphQL Enum type. The first argument is the name of an Enum type as defined in the GraphQL schema being used. The second argument is a function that converts values of some arbitrary source type into String symbols that correspond to the Enum's possible values as defined in the schema.

type AccessLevel
    = AdminAccess
    | MemberAccess


accessLevelToEnumSymbol : AccessLevel -> String
accessLevelToEnumSymbol accessLevel =
    case accessLevel of
        AdminAccess ->
            "ADMIN"


        MemberAccess ->
            "MEMBER"


accessLevel : VariableSpec NonNull AccessLevel
accessLevel =
    enum "AccessLevel" accessLevelToEnumSymbol

Transforms a NonNull VariableSpec into one that allows null values, extracting its value from a Maybe.

Constructs a VariableSpec for a GraphQL List type out of another VariableSpec that represents its items.

Constructs a VariableSpec for a GraphQL Input Object type. The first argument is the name of an Input Object type as defined in the GraphQL schema being used. The second argument is a List of Field values constructed with the field function.

type alias UpdateUserInputData =
    { name : String
    , email : String
    }


userDataVar : Variable { vars | userData : UpdateUserInputData }
userDataVar =
    required "userData"
        .userData
        (object "UpdateUserInput"
            [ field "name" .name string
            , field "email" .email string
            ]
        )

Constructs a Field to be passed to the object function. The first argument is the name of the field. The second argument is a function that extracts this field's value from the value that represents the whole object. See the documentation for object for more details.

Returns the name of a Variable as it appears in a GraphQL request document, without any leading dollar sign ($).

Returns the AST (abstract syntax tree) representation of a Variable.

Extracts generic values from a source and a List of zero or more compatible Variables.