Language.GraphQL.Type

Reexports non-conflicting type system and schema definitions.

Documentation

data InputField

Single field of an InputObjectType.

Constructors

InputField (Maybe Text) Type (Maybe Value)

data InputObjectType

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

Show InputObjectType

Defined in Language.GraphQL.Type.In

Methods

showsPrec :: Int -> InputObjectType -> ShowS

show :: InputObjectType -> String

showList :: [InputObjectType] -> ShowS

Eq InputObjectType

Defined in Language.GraphQL.Type.In

Methods

(==) :: InputObjectType -> InputObjectType -> Bool

(/=) :: InputObjectType -> InputObjectType -> Bool

data Context

Resolution context holds resolver arguments and the root value.

Constructors

Context

Fields

• arguments :: Arguments
• values :: Value

data Field m

Output object field definition.

Constructors

Field

Fields

• (Maybe Text)

  Description.

• (Type m)

  Field type.

• Arguments

  Arguments.

data InterfaceType m

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

Show (InterfaceType a)

Defined in Language.GraphQL.Type.Out

Methods

showsPrec :: Int -> InterfaceType a -> ShowS

show :: InterfaceType a -> String

showList :: [InterfaceType a] -> ShowS

Eq (InterfaceType a)

Defined in Language.GraphQL.Type.Out

Methods

(==) :: InterfaceType a -> InterfaceType a -> Bool

(/=) :: InterfaceType a -> InterfaceType a -> Bool

data ObjectType m

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

Show (ObjectType a)

Defined in Language.GraphQL.Type.Out

Methods

showsPrec :: Int -> ObjectType a -> ShowS

show :: ObjectType a -> String

showList :: [ObjectType a] -> ShowS

Eq (ObjectType a)

Defined in Language.GraphQL.Type.Out

Methods

(==) :: ObjectType a -> ObjectType a -> Bool

(/=) :: ObjectType a -> ObjectType a -> Bool

type Resolve m = ReaderT Context m Value

Monad transformer stack used by the resolvers for determining the resolved value of a field.

data Resolver m

Resolver associates some function(s) with each Field. ValueResolver resolves a Field into a Value. EventStreamResolver resolves additionally a Field into a SourceEventStream if it is the field of a root subscription type.

The resolvers aren't part of the Field itself because not all fields have resolvers (interface fields don't have an implementation).

Constructors

ValueResolver (Field m) (Resolve m)

EventStreamResolver (Field m) (Resolve m) (Subscribe m)

type SourceEventStream m = ConduitT () Value m ()

A source stream represents the sequence of events, each of which will trigger a GraphQL execution corresponding to that event.

type Subscribe m = ReaderT Context m (SourceEventStream m)

Monad transformer stack used by the resolvers for determining the resolved event stream of a subscription field.

data UnionType m

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]

Instances

Show (UnionType a)

Defined in Language.GraphQL.Type.Out

Methods

showsPrec :: Int -> UnionType a -> ShowS

show :: UnionType a -> String

showList :: [UnionType a] -> ShowS

Eq (UnionType a)

Defined in Language.GraphQL.Type.Out

Methods

(==) :: UnionType a -> UnionType a -> Bool

(/=) :: UnionType a -> UnionType a -> Bool

argument :: Monad m => Name -> Resolve m

Retrieves an argument by its name. If the argument with this name couldn't be found, returns Null (i.e. the argument is assumed to be optional then).

newtype Arguments

Argument list.

Constructors

Arguments (HashMap Name Value)

Instances

Monoid Arguments

Defined in Language.GraphQL.Type.Definition

Methods

mempty :: Arguments

mappend :: Arguments -> Arguments -> Arguments

mconcat :: [Arguments] -> Arguments

Semigroup Arguments

Defined in Language.GraphQL.Type.Definition

Methods

(<>) :: Arguments -> Arguments -> Arguments

sconcat :: NonEmpty Arguments -> Arguments

stimes :: Integral b => b -> Arguments -> Arguments

Show Arguments

Defined in Language.GraphQL.Type.Definition

Methods

showsPrec :: Int -> Arguments -> ShowS

show :: Arguments -> String

showList :: [Arguments] -> ShowS

Eq Arguments

Defined in Language.GraphQL.Type.Definition

Methods

(==) :: Arguments -> Arguments -> Bool

(/=) :: Arguments -> Arguments -> Bool

data Directive

Directive.

Constructors

Directive Name Arguments

Instances

Show Directive

Defined in Language.GraphQL.Type.Definition

Methods

showsPrec :: Int -> Directive -> ShowS

show :: Directive -> String

showList :: [Directive] -> ShowS

Eq Directive

Defined in Language.GraphQL.Type.Definition

Methods

(==) :: Directive -> Directive -> Bool

(/=) :: Directive -> Directive -> Bool

data EnumType

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.

Constructors

EnumType Name (Maybe Text) (HashMap Name EnumValue)

Instances

Show EnumType

Defined in Language.GraphQL.Type.Definition

Methods

showsPrec :: Int -> EnumType -> ShowS

show :: EnumType -> String

showList :: [EnumType] -> ShowS

Eq EnumType

Defined in Language.GraphQL.Type.Definition

Methods

(==) :: EnumType -> EnumType -> Bool

(/=) :: EnumType -> EnumType -> Bool

newtype EnumValue

Enum value is a single member of an EnumType.

Constructors

EnumValue (Maybe Text)

data ScalarType

Scalar type definition.

The leaf values of any request and input values to arguments are Scalars (or Enums) .

Constructors

ScalarType Name (Maybe Text)

Instances

Show ScalarType

Defined in Language.GraphQL.Type.Definition

Methods

showsPrec :: Int -> ScalarType -> ShowS

show :: ScalarType -> String

showList :: [ScalarType] -> ShowS

Eq ScalarType

Defined in Language.GraphQL.Type.Definition

Methods

(==) :: ScalarType -> ScalarType -> Bool

(/=) :: ScalarType -> ScalarType -> Bool

type Subs = HashMap Name Value

Contains variables for the query. The key of the map is a variable name, and the value is the variable value.

data 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)

Instances

IsString Value

Defined in Language.GraphQL.Type.Definition

Methods

fromString :: String -> Value

Show Value

Defined in Language.GraphQL.Type.Definition

Methods

showsPrec :: Int -> Value -> ShowS

show :: Value -> String

showList :: [Value] -> ShowS

Eq Value

Defined in Language.GraphQL.Type.Definition

Methods

(==) :: Value -> Value -> Bool

(/=) :: Value -> Value -> Bool

Serialize Value

Defined in Language.GraphQL.Execute.Coerce

Methods

serialize :: forall (m :: Type -> Type). Type m -> Output Value -> Maybe Value

null :: Value

VariableValue Value

Defined in Language.GraphQL.Execute.Coerce

Methods

coerceVariableValue :: Type -> Value -> Maybe Value

boolean :: ScalarType

The Boolean scalar type represents true or false.

float :: ScalarType

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

id :: ScalarType

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

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between \(-2^{31}\) and \(2^{31 - 1}\).

showNonNullType :: Show a => a -> String

showNonNullListType :: Show a => a -> String

selection :: [Directive] -> Maybe [Directive]

Takes a list of directives, handles supported directives and excludes them from the result. If the selection should be skipped, returns Nothing.

string :: ScalarType

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.

data Schema m

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.

schema

Arguments

:: forall m. ObjectType m

Query type.

-> Maybe (ObjectType m)

Mutation type.

-> Maybe (ObjectType m)

Subscription type.

-> Directives

Directive definitions.

-> Schema m

Schema.

Schema constructor.

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 using schemaWithTypes instead.

schemaWithTypes

Arguments

:: forall m. Maybe Text

Schema description

-> ObjectType m

Query type.

-> Maybe (ObjectType m)

Mutation type.

-> Maybe (ObjectType m)

Subscription type.

-> [Type m]

Additional types.

-> Directives

Directive definitions.

-> Schema m

Schema.

Constructs a complete schema, including user-defined types not referenced in the schema directly (for example interface implementations).