Packages

trait GraphQL[-R] extends AnyRef

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.

Self Type
GraphQL[R]
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GraphQL
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract val queryAnalyzers: List[QueryAnalyzer[R]]
    Attributes
    protected
  2. abstract val schema: RootSchema[R]
    Attributes
    protected

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. final def check(query: String): IO[CalibanError, Unit]

    Parses and validates the provided query against this API.

    Parses and validates the provided query against this API.

    query

    a string containing the GraphQL query.

    returns

    an effect that either fails with a CalibanError or succeeds with Unit

  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  7. final def combine[R1 <: R](that: GraphQL[R1]): GraphQL[R1]

    Merges this GraphQL API with another GraphQL API.

    Merges this GraphQL API with another GraphQL API. In case of conflicts (same field declared on both APIs), fields from that API will be used.

    that

    another GraphQL API object

    returns

    a new GraphQL API

  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  11. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. final def interpreter: GraphQLInterpreter[R, CalibanError]

    Creates an interpreter from your API.

    Creates an interpreter from your API. A GraphQLInterpreter is a wrapper around your API that allows adding some middleware around the query execution.

  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. final def rename(queriesName: Option[String] = None, mutationsName: Option[String] = None, subscriptionsName: Option[String] = None): GraphQL[R]

    Renames the root queries, mutations and subscriptions objects.

    Renames the root queries, mutations and subscriptions objects.

    queriesName

    a new name for the root queries object

    mutationsName

    a new name for the root mutations object

    subscriptionsName

    a new name for the root subscriptions object

    returns

    a new GraphQL API

  19. final def render: String

    Returns a string that renders the API types into the GraphQL format.

  20. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  21. def toString(): String
    Definition Classes
    AnyRef → Any
  22. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  24. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  25. final def withQueryAnalyzer[R2 <: R](queryAnalyzer: QueryAnalyzer[R2]): GraphQL[R2]

    Attaches a function that will analyze each query before execution, possibly modify or reject it.

    Attaches a function that will analyze each query before execution, possibly modify or reject it.

    queryAnalyzer

    a function from Field to ZIO[R, CalibanError, Field]

    returns

    a new GraphQL API

  26. final def |+|[R1 <: R](that: GraphQL[R1]): GraphQL[R1]

    Operator alias for combine.

Inherited from AnyRef

Inherited from Any

Ungrouped