caliban

package caliban

Type members

Classlikes

sealed
trait CalibanError extends Throwable with Product with Serializable

The base type for all Caliban errors.

The base type for all Caliban errors.

Companion
object
object CalibanError extends CalibanErrorJsonCompat
Companion
class
trait GraphQL[-R]

A GraphQL[-R] represents a GraphQL API whose execution requires a ZIO environment of type R.

A GraphQL[-R] represents a GraphQL API whose execution requires a ZIO environment of type R.

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.

Companion
object
object GraphQL
Companion
class
trait GraphQLAspect[+LowerR, -UpperR]

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.

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]

A GraphQLInterpreter[-R, +E] represents a GraphQL interpreter whose execution requires a ZIO environment of type R and can fail with an E.

A GraphQLInterpreter[-R, +E] represents a GraphQL interpreter whose execution requires a ZIO environment of type R and can fail with an E.

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.

Companion
object
Companion
class
case
class GraphQLRequest(query: Option[String], operationName: Option[String], variables: Option[Map[String, InputValue]], extensions: Option[Map[String, InputValue]])

Represents a GraphQL request, containing a query, an operation name and a map of variables.

Represents a GraphQL request, containing a query, an operation name and a map of variables.

Companion
object
object GraphQLRequest extends GraphQLRequestJsonCompat
Companion
class
case
class GraphQLResponse[+E](data: ResponseValue, errors: List[E], extensions: Option[ObjectValue])

Represents the result of a GraphQL query, containing a data object and a list of errors.

Represents the result of a GraphQL query, containing a data object and a list of errors.

Companion
object
object GraphQLResponse extends GraphQLResponseJsonCompat
Companion
class
case
class GraphQLWSInput(`type`: String, id: Option[String], payload: Option[InputValue])
Companion
object
object GraphQLWSInput extends GraphQLWSInputJsonCompat
Companion
class
case
class GraphQLWSOutput(`type`: String, id: Option[String], payload: Option[ResponseValue])
Companion
object
object GraphQLWSOutput extends GraphQLWSOutputJsonCompat
Companion
class
sealed
Companion
object
object InputValue extends ValueJsonCompat
Companion
class
object Macros
object Rendering
sealed
Companion
object
object ResponseValue extends ValueJsonCompat
Companion
class
case
class RootResolver[+Query, +Mutation, +Subscription](queryResolver: Option[Query], mutationResolver: Option[Mutation], subscriptionResolver: Option[Subscription])

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.

Companion
object
Companion
class
sealed
trait Value extends InputValue with ResponseValue
Companion
object
object Value
Companion
class