caliban
package caliban
- Alphabetic
- Public
- All
Type Members
-
sealed
trait
CalibanError extends Throwable with Product with Serializable
The base type for all Caliban errors.
-
trait
GraphQL[-R] extends AnyRef
A
GraphQL[-R]
represents a GraphQL API whose execution requires a ZIO environment of typeR
.A
GraphQL[-R]
represents a GraphQL API whose execution requires a ZIO environment of typeR
.It is intended to be created only once, typically when you start your server. The introspection schema will be generated when this class is instantiated.
-
trait
GraphQLAspect[+LowerR, -UpperR] extends AnyRef
A
GraphQLAspect
is wrapping type similar to a polymorphic function, which is capable of transforming a GraphQL into another while possibly enlarging the required environment type.A
GraphQLAspect
is wrapping type similar to a polymorphic function, which is capable of transforming a GraphQL into another while possibly enlarging the required environment type. It allows a flexible way to augment an existing GraphQL with new capabilities or features. -
trait
GraphQLInterpreter[-R, +E] extends AnyRef
A
GraphQLInterpreter[-R, +E]
represents a GraphQL interpreter whose execution requires a ZIO environment of typeR
and can fail with anE
.A
GraphQLInterpreter[-R, +E]
represents a GraphQL interpreter whose execution requires a ZIO environment of typeR
and can fail with anE
.It is a wrapper around a
GraphQL
API definition that allows adding some middleware around query execution, and possibly transform the environment or the error type. -
case class
GraphQLRequest(query: Option[String] = None, operationName: Option[String] = None, variables: Option[Map[String, InputValue]] = None, extensions: Option[Map[String, InputValue]] = None) extends Product with Serializable
Represents a GraphQL request, containing a query, an operation name and a map of variables.
-
case class
GraphQLResponse[+E](data: ResponseValue, errors: List[E], extensions: Option[ObjectValue] = None) extends Product with Serializable
Represents the result of a GraphQL query, containing a data object and a list of errors.
- case class GraphQLWSInput(type: String, id: Option[String], payload: Option[InputValue]) extends Product with Serializable
- case class GraphQLWSOutput(type: String, id: Option[String], payload: Option[ResponseValue]) extends Product with Serializable
- sealed trait InputValue extends AnyRef
- sealed trait ResponseValue extends AnyRef
-
case class
RootResolver[+Query, +Mutation, +Subscription](queryResolver: Option[Query], mutationResolver: Option[Mutation], subscriptionResolver: Option[Subscription]) extends Product with Serializable
A
root resolver
contains resolvers for the 3 types of operations allowed in GraphQL: queries, mutations and subscriptions.A
root resolver
contains resolvers for the 3 types of operations allowed in GraphQL: queries, mutations and subscriptions.A
resolver
is a simple value of the case class describing the API. - sealed trait Value extends InputValue with ResponseValue
Value Members
- object CalibanError extends CalibanErrorJsonCompat with Serializable
- object GraphQL
- object GraphQLInterpreter
- object GraphQLRequest extends GraphQLRequestJsonCompat with Serializable
- object GraphQLResponse extends GraphQLResponseJsonCompat with Serializable
- object GraphQLWSInput extends GraphQLWSInputJsonCompat with Serializable
- object GraphQLWSOutput extends GraphQLWSOutputJsonCompat with Serializable
- object InputValue extends ValueJsonCompat
- object Macros
- object Rendering
- object ResponseValue extends ValueJsonCompat
- object RootResolver extends Serializable
- object Value