Documentation

Single field of an InputObjectType.

Input object type definition.

An input object defines a structured collection of fields which may be supplied to a field argument.

Resolution context holds resolver arguments and the root value.

Output object field definition.

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.

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.

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

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

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

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

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.

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

Argument list.

Directive.

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.

Scalar type definition.

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

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.

The Boolean scalar type represents true or false.

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

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.

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

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

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.

Schema constructor.