object QueryAnalyzer
- Alphabetic
- By Inheritance
- QueryAnalyzer
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- type QueryAnalyzer[-R] = (Field) => ZIO[R, CalibanError, Field]
A query analyzer is a function that takes a root Field and returns a new root Field or fails with a CalibanError.
A query analyzer is a function that takes a root Field and returns a new root Field or fails with a CalibanError. In case of failure, the query will be rejected before execution. The environment
Rcan be used to "inject" some data that will be used by the resolvers (e.g. query cost).
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##(): Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def calculateDepth(field: Field): Int
- def checkMaxDepth(maxDepth: Int): QueryAnalyzer[Any]
Checks that the given field's depth is under a given max
Checks that the given field's depth is under a given max
- maxDepth
the max allowed depth for the field
- def checkMaxFields(maxFields: Int): QueryAnalyzer[Any]
Checks that the given field has a limited number of fields
Checks that the given field has a limited number of fields
- maxFields
the max allowed number of fields inside the given field
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def countFields(field: Field): Int
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def maxDepth[R, E](maxDepth: Int)(api: GraphQL[R]): GraphQL[R]
Attaches to the given GraphQL API definition a function that checks that each query depth is under a given max.
Attaches to the given GraphQL API definition a function that checks that each query depth is under a given max.
- maxDepth
the max allowed depth for a query
- api
a GraphQL API definition
- returns
a new GraphQL API definition
- def maxFields[R, E](maxFields: Int)(api: GraphQL[R]): GraphQL[R]
Attaches to the given GraphQL API definition a function that checks that each query has a limited number of fields.
Attaches to the given GraphQL API definition a function that checks that each query has a limited number of fields.
- maxFields
the max allowed number of fields for a query
- api
a GraphQL API definition
- returns
a new GraphQL API definition
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()