| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
Language.GraphQL.Type.Schema
Description
This module provides a representation of a GraphQL Schema in addition to
functions for defining and manipulating schemas.
Synopsis
- schema :: forall m. ObjectType m -> Maybe (ObjectType m) -> Maybe (ObjectType m) -> Directives -> Schema m
- schemaWithTypes :: forall m. Maybe Text -> ObjectType m -> Maybe (ObjectType m) -> Maybe (ObjectType m) -> [Type m] -> Directives -> Schema m
- data Type m
- data Schema m
- data Directive = Directive (Maybe Text) [DirectiveLocation] Arguments
- type Directives = HashMap Name Directive
- description :: forall m. Schema m -> Maybe Text
- directives :: forall m. Schema m -> Directives
- implementations :: forall m. Schema m -> HashMap Name [Type m]
- mutation :: forall m. Schema m -> Maybe (ObjectType m)
- subscription :: forall m. Schema m -> Maybe (ObjectType m)
- query :: forall m. Schema m -> ObjectType m
- types :: forall m. Schema m -> HashMap Name (Type m)
Documentation
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.
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).
These are all of the possible kinds of types.
Constructors
| ScalarType ScalarType | |
| EnumType EnumType | |
| ObjectType (ObjectType m) | |
| InputObjectType InputObjectType | |
| InterfaceType (InterfaceType m) | |
| UnionType (UnionType 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.
Directive definition.
Constructors
| Directive (Maybe Text) [DirectiveLocation] Arguments |
directives :: forall m. Schema m -> Directives Source #
Schema directive definitions.
subscription :: forall m. Schema m -> Maybe (ObjectType m) Source #
Schema subscription type.
query :: forall m. Schema m -> ObjectType m Source #
Schema query type.