caliban
API
Generated with
caliban/caliban

caliban

package caliban

Members list

Concise view

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.

Attributes

Companion:
object
Graph
Supertypes
trait Product
trait Equals
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Known subtypes
object CalibanError

Attributes

Companion:
trait
Graph
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
object Configurator

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type
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.

Attributes

Companion:
object
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
object GraphQL

Attributes

Companion:
trait
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
GraphQL.type
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.

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait Wrapper[R]
class FieldWrapper[R]
trait SimpleWrapper[R, E, A, Info]
Self type
GraphQLAspect[LowerR, UpperR]
case class GraphQLIncrementalResponse[+E](incremental: List[Incremental[E]], hasNext: Boolean)

Attributes

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object GraphQLIncrementalResponse

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
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.

Attributes

Companion:
object
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
object GraphQLInterpreter

Attributes

Companion:
trait
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
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.

Attributes

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object GraphQLRequest

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class GraphQLResponse[+E](data: ResponseValue, errors: List[E], extensions: Option[ObjectValue], hasNext: Option[Boolean])

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.

Attributes

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object GraphQLResponse

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class GraphQLWSClose(code: Int, reason: String)

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case class GraphQLWSInput(`type`: String, id: Option[String], payload: Option[InputValue])

Attributes

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object GraphQLWSInput

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class GraphQLWSOutput(`type`: String, id: Option[String], payload: Option[ResponseValue])

Attributes

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object GraphQLWSOutput

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed trait Incremental[+E] extends Product with Serializable

Attributes

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Known subtypes
class Defer[E]
object Incremental

Attributes

Companion:
trait
Graph
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed trait InputValue

Attributes

Companion:
object
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class ListValue
trait Value
class EnumValue
trait IntValue
class IntNumber
object NullValue.type
object InputValue

Attributes

Companion:
trait
Graph
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
object Macros

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type
Macros.type
object Rendering

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type
sealed trait ResponseValue

Attributes

Companion:
object
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class ListValue
trait Value
class EnumValue
trait IntValue
class IntNumber
object NullValue.type
Self type
object ResponseValue

Attributes

Companion:
trait
Graph
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
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.

Attributes

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object RootResolver

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed trait Value extends InputValue with ResponseValue

Attributes

Companion:
object
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class EnumValue
trait IntValue
class IntNumber
object NullValue.type
object Value

Attributes

Companion:
trait
Graph
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
Value.type

Value members

Concrete methods

def graphQL[R, Q, M, S : SubscriptionSchema](resolver: RootResolver[Q, M, S], directives: List[`__Directive`], schemaDirectives: List[Directive])(implicit evidence$1: SubscriptionSchema[S], querySchema: Schema[R, Q], mutationSchema: Schema[R, M], subscriptionSchema: Schema[R, S]): GraphQL[R]

Builds a GraphQL API for the given resolver.

Builds a GraphQL API for the given resolver.

It requires an instance of caliban.schema.Schema for each operation type. This schema will be derived by Magnolia automatically.

Attributes

Generated with