p

caliban

package caliban

Ordering
  1. Alphabetic
Visibility
  1. Public
  2. Protected

Package Members

  1. package execution
  2. package interop
  3. package introspection
  4. package parsing
  5. package relay
  6. package schema
  7. package uploads
  8. package validation
  9. package wrappers

Type Members

  1. sealed trait CalibanError extends Throwable with Product with Serializable

    The base type for all Caliban errors.

  2. trait GraphQL[-R] extends AnyRef

    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.

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

  4. trait GraphQLInterpreter[-R, +E] extends AnyRef

    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.

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

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

  7. case class GraphQLWSClose(code: Int, reason: String) extends Product with Serializable
  8. case class GraphQLWSInput(type: String, id: Option[String], payload: Option[InputValue]) extends Product with Serializable
  9. case class GraphQLWSOutput(type: String, id: Option[String], payload: Option[ResponseValue]) extends Product with Serializable
  10. sealed trait InputValue extends AnyRef
  11. sealed trait ResponseValue extends AnyRef
  12. 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.

  13. sealed trait Value extends InputValue with ResponseValue

Value Members

  1. object CalibanError extends CalibanErrorJsonCompat with Serializable
  2. object GraphQL
  3. object GraphQLInterpreter
  4. object GraphQLRequest extends GraphQLRequestJsonCompat with Serializable
  5. object GraphQLResponse extends GraphQLResponseJsonCompat with Serializable
  6. object GraphQLWSInput extends GraphQLWSInputJsonCompat with Serializable
  7. object GraphQLWSOutput extends GraphQLWSOutputJsonCompat with Serializable
  8. object InputValue extends ValueJsonCompat
  9. object Macros
  10. object Rendering
  11. object ResponseValue extends ValueJsonCompat
  12. object RootResolver extends Serializable
  13. object Value

Ungrouped