| Safe Haskell | Safe |
|---|---|
| Language | Haskell2010 |
Language.GraphQL.Type
Description
Reexports non-conflicting type system and schema definitions.
Synopsis
- data InputField = InputField (Maybe Text) Type (Maybe Value)
- data InputObjectType = InputObjectType Name (Maybe Text) (HashMap Name InputField)
- data Field m = Field (Maybe Text) (Type m) (HashMap Name Argument)
- data InterfaceType m = InterfaceType Name (Maybe Text) [InterfaceType m] (HashMap Name (Field m))
- data ObjectType m = ObjectType Name (Maybe Text) [InterfaceType m] (HashMap Name (Resolver m))
- data UnionType m = UnionType Name (Maybe Text) [ObjectType m]
- data EnumType = EnumType Name (Maybe Text) (HashMap Name EnumValue)
- newtype EnumValue = EnumValue (Maybe Text)
- data ScalarType = ScalarType Name (Maybe Text)
- type Subs = HashMap Name Value
- data Value
- boolean :: ScalarType
- float :: ScalarType
- id :: ScalarType
- int :: ScalarType
- string :: ScalarType
- data Schema m = Schema {
- query :: ObjectType m
- mutation :: Maybe (ObjectType m)
Documentation
data InputField Source #
Single field of an InputObjectType.
data InputObjectType Source #
Input object type definition.
An input object defines a structured collection of fields which may be supplied to a field argument.
Constructors
| InputObjectType Name (Maybe Text) (HashMap Name InputField) |
Instances
| Eq InputObjectType Source # | |
Defined in Language.GraphQL.Type.In Methods (==) :: InputObjectType -> InputObjectType -> Bool # (/=) :: InputObjectType -> InputObjectType -> Bool # | |
Output object field definition.
data InterfaceType m Source #
Interface Type Definition.
When a field can return one of a heterogeneous set of types, a Interface type is used to describe what types are possible, and what fields are in common across all types.
Constructors
| InterfaceType Name (Maybe Text) [InterfaceType m] (HashMap Name (Field m)) |
Instances
| Eq (InterfaceType a) Source # | |
Defined in Language.GraphQL.Type.Out Methods (==) :: InterfaceType a -> InterfaceType a -> Bool # (/=) :: InterfaceType a -> InterfaceType a -> Bool # | |
data ObjectType m Source #
Object type definition.
Almost all of the GraphQL types you define will be object types. Object types have a name, but most importantly describe their fields.
Constructors
| ObjectType Name (Maybe Text) [InterfaceType m] (HashMap Name (Resolver m)) |
Instances
| Eq (ObjectType a) Source # | |
Defined in Language.GraphQL.Type.Out | |
Union Type Definition.
When a field can return one of a heterogeneous set of types, a Union type is used to describe what types are possible.
Constructors
| UnionType Name (Maybe Text) [ObjectType m] |
Enum type definition.
Some leaf values of requests and input values are Enums. GraphQL serializes Enum values as strings, however internally Enums can be represented by any kind of type, often integers.
Enum value is a single member of an EnumType.
data ScalarType Source #
Scalar type definition.
The leaf values of any request and input values to arguments are Scalars (or Enums) .
Constructors
| ScalarType Name (Maybe Text) |
Instances
| Eq ScalarType Source # | |
Defined in Language.GraphQL.Type.Definition | |
type Subs = HashMap Name Value Source #
Contains variables for the query. The key of the map is a variable name, and the value is the variable value.
Represents accordingly typed GraphQL values.
Constructors
| Int Int32 | |
| Float Double | GraphQL Float is double precision. |
| String Text | |
| Boolean Bool | |
| Null | |
| Enum Name | |
| List [Value] | Arbitrary nested list. |
| Object (HashMap Name Value) |
boolean :: ScalarType Source #
The Boolean scalar type represents true or false.
float :: ScalarType Source #
The Float scalar type represents signed double-precision fractional
values as specified by
IEEE 754.
id :: ScalarType Source #
The ID scalar type represents a unique identifier, often used to refetch
an object or as key for a cache. The ID type appears in a JSON response as a
String; however, it is not intended to be human-readable. When expected as an
input type, any string (such as "4") or integer (such as 4) input value
will be accepted as an ID.
int :: ScalarType Source #
The Int scalar type represents non-fractional signed whole numeric
values. Int can represent values between \(-2^{31}\) and \(2^{31 - 1}\).
string :: ScalarType Source #
The String scalar type represents textual data, represented as UTF-8
character sequences. The String type is most often used by GraphQL to
represent free-form human-readable text.
A Schema is created by supplying the root types of each type of operation, query and mutation (optional). A schema definition is then supplied to the validator and executor.
Note: When the schema is constructed, by default only the types that are reachable by traversing the root types are included, other types must be explicitly referenced.
Constructors
| Schema | |
Fields
| |