gql
Members list
Packages
Type members
Classlikes
A small free algebra for combining arguments and decoding them.
A small free algebra for combining arguments and decoding them. ArgDecoder can trivially be lifted into Arg with loss of field-level information.
Note that Arg must be non-empty, and therefore it does not form an cats.Applicative, but instead it forms cats.Apply.
Attributes
A combination of an argument declaration ArgParam and a decoder function for ArgParam. This structure is more specialized than just decoding with Arg, since you will have access to field specific information such as if the argument was provided explicitly or the default was used.
The trivial implementation of an ArgDecoder given an ArgValue:
val av: ArgValue[A] = ???
ArgDecoder[A, A](av, _.value.asRight)
Attributes
- Source
- Arg.scala
- Supertypes
A GraphQL argument value suppled in respect to a declared ArgValue, usually provided by a calling client.
A GraphQL argument declaration with an optional default value.
A GraphQL argument declaration with an optional default value. The argument references an input type, which is suspended in Eval for recursion.
Attributes
- Source
- Arg.scala
- Supertypes
Attributes
- Source
- ast.scala
- Supertypes
- Self type
-
AstImplicits.type
A collection of GraphQL arcs wraped up with an associated algebra.
A collection of GraphQL arcs wraped up with an associated algebra. Usually used for reporting where an error occured.
Attributes
- Companion
- object
- Source
- Cursor.scala
- Supertypes
Attributes
- Companion
- class
- Source
- Cursor.scala
- Supertypes
- Self type
-
Cursor.type
A Directive takes an argument A and performs some context specific ast transformation.
A Directive takes an argument A and performs some context specific ast transformation.
Attributes
- Companion
- object
- Source
- Directive.scala
- Supertypes
Consider taking a look at the skip and include directives as an example.
Consider taking a look at the skip and include directives as an example.
Attributes
- Companion
- class
- Source
- Directive.scala
- Supertypes
- Self type
-
Directive.type
Attributes
- Companion
- trait
- Source
- Arg.scala
- Supertypes
- Self type
-
EmptyableArg.type
One arc in a GraphQL path.
One arc in a GraphQL path.
Attributes
- Companion
- object
- Source
- Cursor.scala
- Supertypes
- Known subtypes
Attributes
- Companion
- trait
- Source
- Cursor.scala
- Supertypes
- Self type
-
GraphArc.type
Attributes
- Companion
- object
- Source
- Modifier.scala
- Supertypes
- Known subtypes
Attributes
- Companion
- trait
- Source
- Modifier.scala
- Supertypes
- Self type
-
InverseModifier.type
The Scala counterpart to ModifierStack.
The Scala counterpart to ModifierStack.
Note that they are not equivalent, since ModifierStack explicitly declares Modifier.NonNull, while InverseModifierStack explicitly declares the opposite; InverseModifier.Optional.
Attributes
- Companion
- object
- Source
- Modifier.scala
- Supertypes
Attributes
- Companion
- class
- Source
- Modifier.scala
- Supertypes
- Self type
-
InverseModifierStack.type
Attributes
- Companion
- object
- Source
- Modifier.scala
- Supertypes
- Known subtypes
Attributes
- Companion
- trait
- Source
- Modifier.scala
- Supertypes
- Self type
-
Modifier.type
A very convinient algebra for transforming GraphQL types with modifiers.
A very convinient algebra for transforming GraphQL types with modifiers. It can take a GraphQL type to a Scala type and back.
Attributes
- Companion
- object
- Source
- Modifier.scala
- Supertypes
Attributes
- Companion
- class
- Source
- Modifier.scala
- Supertypes
- Self type
-
ModifierStack.type
Attributes
- Companion
- object
- Source
- Directive.scala
- Supertypes
- Known subtypes
Attributes
- Companion
- trait
- Source
- Directive.scala
- Supertypes
- Self type
-
Position.type
The neccessary parameters to execute a GraphQL query.
The neccessary parameters to execute a GraphQL query. QueryParameters is usually provided by a calling client.
Attributes
- Source
- QueryParameters.scala
- Supertypes
The result of executing a GraphQL query.
The result of executing a GraphQL query. Errors thrown during evaluation can be handled with a partial function.
Attributes
- Companion
- object
- Source
- QueryResult.scala
- Supertypes
Attributes
- Companion
- class
- Source
- QueryResult.scala
- Supertypes
- Self type
-
QueryResult.type
The underlying graph that compiles into a GraphQL schema.
The underlying graph that compiles into a GraphQL schema. Provides a plethora of methods to derive information, perform validation, render, introspect and generate stub implementations.
Attributes
- Companion
- object
- Source
- SchemaShape.scala
- Supertypes
Attributes
- Companion
- class
- Source
- SchemaShape.scala
- Supertypes
- Self type
-
SchemaShape.type
A structure to accumulate information for building stateful schemas.
A structure to accumulate information for building stateful schemas. Needed to build batch functions and directives.
Attributes
- Companion
- object
- Source
- SchemaState.scala
- Supertypes
Attributes
- Companion
- class
- Source
- SchemaState.scala
- Supertypes
- Self type
-
SchemaState.type
Attributes
- Source
- Validation.scala
- Supertypes
- Self type
-
Validation.type
A tree-like structure representing a GraphQL schema, akin to most schema builders.
A tree-like structure representing a GraphQL schema, akin to most schema builders.