p

caliban

package caliban

Ordering
  1. Alphabetic
Visibility
  1. Public
  2. Protected

Package Members

  1. package execution
  2. package introspection
  3. package parsing
  4. package schema
  5. package validation

Type Members

  1. sealed trait CalibanError extends Throwable

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

  4. case class GraphQLRequest(query: String, operationName: Option[String], variables: Option[Map[String, InputValue]]) extends Product with Serializable

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

  5. case class GraphQLResponse[+E](data: ResponseValue, errors: List[E]) extends Product with Serializable

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

  6. sealed trait InputValue extends AnyRef
  7. sealed trait ResponseValue extends AnyRef
  8. case class RootResolver[+Query, +Mutation, +Subscription](queryResolver: 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.

    It's mandatory to have a query resolver, the 2 others are optional.

  9. sealed trait Value extends InputValue with ResponseValue

Value Members

  1. object CalibanError extends Serializable
  2. object GraphQL
  3. object GraphQLRequest extends Serializable
  4. object GraphQLResponse extends Serializable
  5. object InputValue
  6. object Macros
  7. object Rendering
  8. object ResponseValue
  9. object RootResolver extends Serializable
  10. object Value

Ungrouped